Struct chewing::dictionary::TrieBuf

pub struct TrieBuf { /* private fields */ }

Implementations

impl TrieBuf

pub fn open<P: Into<PathBuf>>(path: P) -> Result<TrieBuf>

pub fn new_in_memory() -> TrieBuf

Trait Implementations

impl Debug for TrieBuf

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

Formats the value using the given formatter.

impl Dictionary for TrieBuf

fn lookup_first_n_phrases( &self, syllables: &dyn SyllableSlice, first: usize ) -> Vec<Phrase>

Returns first N phrases matched by the syllables.

fn entries(&self) -> Entries<'_>

Returns an iterator to all phrases in the dictionary.

fn about(&self) -> DictionaryInfo

Returns information about the dictionary instance.

fn path(&self) -> Option<&Path>

Returns the dictionary file path if it’s backed by a file.

fn as_dict_mut(&mut self) -> Option<&mut dyn DictionaryMut>

fn lookup_first_phrase(&self, syllables: &dyn SyllableSlice) -> Option<Phrase>

Returns the first phrase matched by the syllables.

fn lookup_all_phrases(&self, syllables: &dyn SyllableSlice) -> Vec<Phrase>

Returns all phrases matched by the syllables.

impl DictionaryMut for TrieBuf

fn reopen(&mut self) -> Result<(), UpdateDictionaryError>

Reopens the dictionary if it was changed by a different process

fn flush(&mut self) -> Result<(), UpdateDictionaryError>

Flushes all the changes back to the filesystem

fn add_phrase( &mut self, syllables: &dyn SyllableSlice, phrase: Phrase ) -> Result<(), UpdateDictionaryError>

An method for updating dictionaries.

fn update_phrase( &mut self, syllables: &dyn SyllableSlice, phrase: Phrase, user_freq: u32, time: u64 ) -> Result<(), UpdateDictionaryError>

TODO: doc

fn remove_phrase( &mut self, syllables: &dyn SyllableSlice, phrase_str: &str ) -> Result<(), UpdateDictionaryError>

TODO: doc

impl Drop for TrieBuf

fn drop(&mut self)

Executes the destructor for this type.

impl<P: Into<Phrase>, const N: usize> From<[(Vec<Syllable>, Vec<P>); N]> for TrieBuf

fn from(value: [(Vec<Syllable>, Vec<P>); N]) -> Self

Converts to this type from the input type.