Struct Engine 

pub struct Engine {
    pub word_regex: Regex,
    pub local_ignore_file: PathBuf,
    pub local_ignored_words: HashSet<String>,
    pub global_ignore_file: PathBuf,
    pub global_ignored_words: HashSet<String>,
    /* private fields */
}

Fields

word_regex: Regex

local_ignore_file: PathBuf

local_ignored_words: HashSet<String>

global_ignore_file: PathBuf

global_ignored_words: HashSet<String>

Implementations

impl Engine

pub fn new(path: &Path) -> Engine

Instantiate owl engine for checking words with ignores.

pub fn get_misspelled(&self, path: &str) -> Vec<WordBad>

Run spellcheck on file, returning WordBad per match.

Return values are not deduped yet.

pub fn get_ignore_status(&self, word: &str) -> Status

Check if a word is ignored.

pub fn suggest(&self, word: &str, suggestions: &mut Vec<String>)

Make suggestions using underlying library.

TODO: incorporate ignores?

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