Struct Engine 

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

Fields

word_regex: Regex

config_file: PathBuf

global_ignore_file: PathBuf

config: Config

local_ignored_words: HashSet<String>

global_ignored_words: HashSet<String>

Implementations

impl Engine

pub fn new(path: &Path) -> Result<Self, OwlError>

Instantiate owl engine for checking words with ignores.

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

Run spellcheck on file, returning WordBad per match.

Return values are not deduped yet.

pub fn get_misspelled_from_lines( &self, lines: &[String], filename: &str, ) -> Vec<WordBad>

pub fn add_global_ignore(&mut self, word: &str) -> Result<(), OwlError>

pub fn delete_global_ignore(&mut self, word: &str) -> Result<(), OwlError>

pub fn add_local_ignore(&mut self, word: &str) -> Result<(), OwlError>

pub fn delete_local_ignore(&mut self, word: &str) -> Result<(), OwlError>

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

Trait Implementations

impl Debug for Engine

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

Formats the value using the given formatter.