Struct MutableDictionary

pub struct MutableDictionary { /* private fields */ }

A basic dictionary that allows words to be added after instantiating. This is useful for user and file dictionaries that may change at runtime.

For immutable use-cases, such as the curated dictionary, prefer super::FstDictionary, as it is much faster.

To combine the contents of multiple dictionaries, regardless of type, use super::MergedDictionary.

Implementations

impl MutableDictionary

pub fn new() -> Self

pub fn curated() -> Arc<Self>

Create a dictionary from the curated dictionary included in the Harper binary. Consider using super::FstDictionary::curated() instead, as it is more performant for spellchecking.

pub fn extend_words( &mut self, words: impl IntoIterator<Item = (impl AsRef<[char]>, WordMetadata)>, )

Appends words to the dictionary. It is significantly faster to append many words with one call than many distinct calls to this function.

pub fn append_word(&mut self, word: impl AsRef<[char]>, metadata: WordMetadata)

Append a single word to the dictionary.

If you are appending many words, consider using Self::extend_words instead.

pub fn append_word_str(&mut self, word: &str, metadata: WordMetadata)

Append a single string to the dictionary.

If you are appending many words, consider using Self::extend_words instead.

Trait Implementations

impl Clone for MutableDictionary

fn clone(&self) -> MutableDictionary

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MutableDictionary

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

Formats the value using the given formatter.

impl Default for MutableDictionary

fn default() -> Self

Returns the “default value” for a type.

impl Dictionary for MutableDictionary

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

Suggest a correct spelling for a given misspelled word. Self::word is assumed to be quite small (n < 100). max_distance relates to an optimization that allows the search algorithm to prune large portions of the search.

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

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

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_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 get_correct_capitalization_of(&self, word: &[char]) -> Option<&[char]>

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

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.

impl PartialEq for MutableDictionary

fn eq(&self, other: &MutableDictionary) -> 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.

impl Eq for MutableDictionary

impl StructuralPartialEq for MutableDictionary