Struct BioReader

pub struct BioReader { /* private fields */ }

A BioReader object, allowing for customizing the bio-reading experience.

Implementations

impl BioReader

pub fn new() -> Self

Create a new BioReader object.

pub fn emphasize(self, f: fn(_: &str) -> String) -> Self

Set the function to emphasize part of a word. Default to bold if environment supports it.

Example

use bio_read::BioReader;
let reader = BioReader::new().emphasize(|s| format!("**{s}**")); // Emphasize by wrapping with `**`
assert_eq!(reader.bio_read_text("hello world"), "**hel**lo **wor**ld");

See also

Other methods that can be used to customize the BioReader:

• BioReader::de_emphasize
• BioReader::fixation_point

pub fn de_emphasize(self, f: fn(_: &str) -> String) -> Self

Set the function to de-emphasize part of a word. Default to dimmed if environment supports it.

Example

use bio_read::BioReader;
let reader = BioReader::new().de_emphasize(|s| format!("_{s}_")); // De-emphasize by wrapping with `_`
assert_eq!(reader.bio_read_text("hello world"), "hel_lo_ wor_ld_");

See also

Other methods that can be used to customize the BioReader:

• BioReader::emphasize
• BioReader::fixation_point

pub fn fixation_point(self, fixation_point: usize) -> Self

Set the fixation point. The lower the fixation point, the more characters will be emphasized. The fixation_point should be in range [1, 5], defaulting to 3 when not specified.

Example

use bio_read::BioReader;
let reader = BioReader::new()
    .emphasize(|s| format!("**{s}**"))
    .fixation_point(1); // Set fixation point to 1
assert_eq!(reader.bio_read_word("pneumonoultramicroscopicsilicovolcanoconiosis"), "**pneumonoultramicroscopicsilicovolcano**coniosis");
let reader = BioReader::new()
    .emphasize(|s| format!("**{s}**"))
    .fixation_point(5); // Set fixation point to 5
assert_eq!(reader.bio_read_word("pneumonoultramicroscopicsilicovolcanoconiosis"), "**pneumonoult**ramicroscopicsilicovolcanoconiosis");

Panics

Panics if fixation_point is not in range [1, 5].

See also

Other methods that can be used to customize the BioReader:

• BioReader::emphasize
• BioReader::de_emphasize

pub fn bio_read_word(&self, word: &str) -> String

Do bio-reading on a word.

See also

BioReader::bio_read_text: Do bio-reading on a piece of text.

pub fn bio_read_text(&self, text: &str) -> String

Do bio-reading on a piece of text.

See also

BioReader::bio_read_word: Do bio-reading on a word.