Struct rspell::Spell

pub struct Spell { /* fields omitted */ }

This is the main structure. It allows to gather dictionaries for a given language and spellcheck individual word or whole text using it.

Examples

let spell = rspell::Spell::new("en_US").unwrap();

assert!(!spell.check_word("colour").correct());
assert!(spell.check_word("color").correct());

for bad in spell.check("Wht color is this flg?") {
    println!(
        "{} (offset: {}): possible corrections: {:?}",
        bad.word, bad.offset, bad.suggestions
    );
}

Methods

impl Spell

pub fn new(lang: &str) -> Result<Spell, SpellError>

Creates a new spellchecker for the given language code.

This function will also ensure that data files for the language are available. If not it will try to get it using a LangProvider.

pub fn check_word(&self, word: &str) -> SpellResult

Checks spelling for the given word.

pub fn check<'a>(&self, text: &'a str) -> Vec<BadWord<'a>>

Checks spelling for the given text.

Word boundaries are determined using unicode segmentation rules.