Struct Checker

pub struct Checker(/* private fields */);

Instance of the system spell checker.

Implementations

impl Checker

pub fn new() -> Self

Create an instance of the system spell checker.

pub fn check<'a, 'b: 'a>( &'b mut self, text: &'a str, ) -> impl Iterator<Item = SpellingError> + 'a

Check a text for spelling errors. Returns an iterator over the errors present in the text.

pub fn ignore(&mut self, word: &str)

Instructs the spell checker to ignore a word in future checks. The word is temporarily added to the spell checker’s ignore list, and other instances of the spell checker will not ignore the word.

Trait Implementations

impl Debug for Checker

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

Formats the value using the given formatter.