Trait harper_core::Dictionary

pub trait Dictionary: Clone {
    // Required methods
    fn contains_word(&self, word: &[char]) -> bool;
    fn contains_word_str(&self, word: &str) -> bool;
    fn words_iter(&self) -> impl Iterator<Item = &[char]>;
    fn words_with_len_iter(
        &self,
        len: usize,
    ) -> Box<dyn Iterator<Item = &[char]> + '_>;
    fn get_word_metadata(&self, word: &[char]) -> WordMetadata;
    fn get_word_metadata_str(&self, word: &str) -> WordMetadata;
}

Required Methods

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 words_iter(&self) -> impl Iterator<Item = &[char]>

Produce an iterator over all words in the dictionary.

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

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

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.

Object Safety

This trait is not object safe.

Implementors

impl Dictionary for FullDictionary

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

impl<T> Dictionary for MergedDictionary<T>

where T: Dictionary + Clone,