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 MutableDictionary.

Implementations

impl FstDictionary

pub fn curated() -> Arc<Self>

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

pub fn new(words: Vec<(CharString, WordMetadata)>) -> Self

Construct a new FstDictionary using a word list as a source. This can be expensive, so only use this if fast fuzzy searches are worth it.

Trait Implementations

impl Dictionary for FstDictionary

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

Check if the dictionary contains any capitalization of a given word.

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

Check if the dictionary contains any capitalization of a given word.

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

Get the associated WordMetadata for any capitalization of a given word.

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

Get the associated WordMetadata for any capitalization of 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 word_count(&self) -> usize

The number of words in the dictionary.

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

Check if the dictionary contains the exact capitalization of a given word.

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

Check if the dictionary contains the exact capitalization of a given word.

fn get_correct_capitalization_of(&self, word: &[char]) -> Option<&[char]>

fn get_word_from_id(&self, id: &WordId) -> Option<&[char]>

Returns the correct capitalization of the word with the given ID.

impl From<MutableDictionary> for FstDictionary

fn from(dict: MutableDictionary) -> Self

Converts to this type from the input type.

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.