Struct cedarwood::Cedar

pub struct Cedar { /* fields omitted */ }

Cedar holds all of the information about double array trie.

Methods

impl Cedar

pub fn new() -> Self

Initialize the Cedar for further use.

pub fn build(&mut self, key_values: &[(&str, i32)])

Build the double array trie from the given key value pairs

pub fn update(&mut self, key: &str, value: i32)

Update the key for the value, it is public interface that works on &str

pub fn erase(&mut self, key: &str)

Delete the key from the trie, the public interface that works on &str

pub fn exact_match_search(&self, key: &str) -> Option<(i32, usize, usize)>

To check if key is in the dictionary.

Important traits for PrefixIter<'a>

impl<'a> Iterator for PrefixIter<'a> type Item = (i32, usize);

pub fn common_prefix_iter<'a>(&'a self, key: &'a str) -> PrefixIter<'a>

To return an iterator to iterate through the common prefix in the dictionary with the key passed in.

pub fn common_prefix_search(&self, key: &str) -> Option<Vec<(i32, usize)>>

To return the collection of the common prefix in the dictionary with the key passed in.

Important traits for PrefixPredictIter<'a>

impl<'a> Iterator for PrefixPredictIter<'a> type Item = (i32, usize);

pub fn common_prefix_predict_iter<'a>(
    &'a self,
    key: &'a str
) -> PrefixPredictIter<'a>

To return an iterator to iterate through the list of words in the dictionary that has key as their prefix.

pub fn common_prefix_predict(&self, key: &str) -> Option<Vec<(i32, usize)>>

To return the list of words in the dictionary that has key as their prefix.

Trait Implementations

impl Clone for Cedar

fn clone(&self) -> Cedar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cedar

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

Formats the value using the given formatter.