Trait Dictionary 

pub trait Dictionary: Send + Sync {
    // Required methods
    fn contains_word(&self, word: &[char]) -> bool;
    fn contains_word_str(&self, word: &str) -> bool;
    fn contains_exact_word(&self, word: &[char]) -> bool;
    fn contains_exact_word_str(&self, word: &str) -> bool;
    fn fuzzy_match(
        &self,
        word: &[char],
        max_distance: u8,
        max_results: usize,
    ) -> Vec<FuzzyMatchResult<'_>>;
    fn fuzzy_match_str(
        &self,
        word: &str,
        max_distance: u8,
        max_results: usize,
    ) -> Vec<FuzzyMatchResult<'_>>;
    fn get_correct_capitalization_of(&self, word: &[char]) -> Option<&[char]>;
    fn get_lexeme_metadata(
        &self,
        word: &[char],
    ) -> Option<Cow<'_, DictWordMetadata>>;
    fn get_lexeme_metadata_str(
        &self,
        word: &str,
    ) -> Option<Cow<'_, DictWordMetadata>>;
    fn words_iter(&self) -> Box<dyn Iterator<Item = &[char]> + Send + '_>;
    fn word_count(&self) -> usize;
    fn get_word_from_id(&self, id: &WordId) -> Option<&[char]>;
}

An in-memory database that contains everything necessary to parse and analyze English text.

See also: super::FstDictionary and super::MutableDictionary.

Required Methods

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

fn get_lexeme_metadata( &self, word: &[char], ) -> Option<Cow<'_, DictWordMetadata>>

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

fn get_lexeme_metadata_str( &self, word: &str, ) -> Option<Cow<'_, DictWordMetadata>>

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

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 get_word_from_id(&self, id: &WordId) -> Option<&[char]>

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

Implementations on Foreign Types

impl<D: Dictionary + ?Sized> Dictionary for Arc<D>

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

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

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

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

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

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

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

fn get_lexeme_metadata( &self, word: &[char], ) -> Option<Cow<'_, DictWordMetadata>>

fn get_lexeme_metadata_str( &self, word: &str, ) -> Option<Cow<'_, DictWordMetadata>>

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

fn word_count(&self) -> usize

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

Implementors

impl Dictionary for FstDictionary

impl Dictionary for MergedDictionary

impl Dictionary for MutableDictionary