Struct FstDictionary

pub struct FstDictionary { /* private fields */ }

An immutable dictionary allowing for very fast spellchecking.

For dictionaries with changing contents, such as user and file dictionaries, prefer super::MutableDictionary.

Implementations

impl FstDictionary

pub fn curated() -> Arc<Self>

Create a dictionary from the curated dictionary included in the Harper binary.

pub fn new(new_words: HashMap<CharString, WordMetadata>) -> Self

Trait Implementations

impl Dictionary for FstDictionary

fn contains_word(&self, word: &[char]) -> bool

Check if the dictionary contains a given word.

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

Check if the dictionary contains a given word.

fn get_word_metadata(&self, word: &[char]) -> WordMetadata

Get the associated WordMetadata for a given word. If the word isn’t in the dictionary, the resulting metadata will be empty.

fn get_word_metadata_str(&self, word: &str) -> WordMetadata

Get the associated WordMetadata for a given word. If the word isn’t in the dictionary, the resulting metadata will be empty.

fn fuzzy_match( &self, word: &[char], max_distance: u8, max_results: usize, ) -> Vec<FuzzyMatchResult<'_>>

Gets best fuzzy match from dictionary

fn fuzzy_match_str( &self, word: &str, max_distance: u8, max_results: usize, ) -> Vec<FuzzyMatchResult<'_>>

Gets best fuzzy match from dictionary

fn words_iter(&self) -> Box<dyn Iterator<Item = &[char]> + Send + '_>

Iterate over the words in the dictionary.

fn words_with_len_iter( &self, len: usize, ) -> Box<dyn Iterator<Item = &[char]> + Send + '_>

Iterate over all the words in the dictionary of a given length

impl PartialEq for FstDictionary

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.