Struct Checker 

pub struct Checker<'a, S: BuildHasher> { /* private fields */ }

A wrapper struct for a dictionary that allows customizing checking behavior.

Implementations

impl<'a, S: BuildHasher> Checker<'a, S>

pub fn check_lower_as_title(self, check_lower_as_title: bool) -> Self

Configures the Checker to check lowercase words in titlecase form.

Normally lowercase words are checked in titlecase or uppercase forms. For example “Alice” is correct in the en_US dictionary but not “alice,” and “RSVP” is correct but not “rsvp.”

Example

let aff = std::fs::read_to_string("./vendor/en_US/en_US.aff").unwrap();
let dic = std::fs::read_to_string("./vendor/en_US/en_US.dic").unwrap();
let dict = spellbook::Dictionary::new(&aff, &dic).unwrap();

assert!(!dict.check("alice"));
assert!(dict.checker().check_lower_as_title(true).check("alice"));

pub fn check_lower_as_upper(self, check_lower_as_upper: bool) -> Self

Configures the Checker to check lowercase words in uppercase form.

See Checker::check_lower_as_title.

Example

let aff = std::fs::read_to_string("./vendor/en_US/en_US.aff").unwrap();
let dic = std::fs::read_to_string("./vendor/en_US/en_US.dic").unwrap();
let dict = spellbook::Dictionary::new(&aff, &dic).unwrap();

assert!(!dict.check("rsvp"));
assert!(dict.checker().check_lower_as_upper(true).check("rsvp"));

pub fn check(&self, word: &str) -> bool

Checks that the word is valid according to the dictionary.

impl<'a, S: BuildHasher> Checker<'a, S>

pub fn into_suggester(self) -> Suggester<'a, S>

Converts the Checker into a Suggester with default suggester options set.

Trait Implementations

impl<'a, S: Clone + BuildHasher> Clone for Checker<'a, S>

fn clone(&self) -> Checker<'a, S>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: BuildHasher> Debug for Checker<'_, S>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, S: Copy + BuildHasher> Copy for Checker<'a, S>