Struct trie_rs::map::Trie

pub struct Trie<Label, Value> { /* private fields */ }

A trie for sequences of the type Label; each sequence has an associated Value.

Implementations

impl<Label: Ord, Value> Trie<Label, Value>

pub fn exact_match(&self, query: impl AsRef<[Label]>) -> Option<&Value>

Return Some(&Value) if query is an exact match.

pub fn exact_match_mut( &mut self, query: impl AsRef<[Label]> ) -> Option<&mut Value>

Return Some(&mut value) if query is an exact match.

pub fn inc_search(&self) -> IncSearch<'_, Label, Value>

Create an incremental search. Useful for interactive applications. See crate::inc_search for details.

pub fn is_prefix(&self, query: impl AsRef<[Label]>) -> bool

Return true if query is a prefix.

Note: A prefix may be an exact match or not, and an exact match may be a prefix or not.

pub fn predictive_search<C, M>( &self, query: impl AsRef<[Label]> ) -> SearchIter<'_, Label, Value, C, M>

where C: TryFromIterator<Label, M> + Clone, Label: Clone,

Return all entries and their values that match query.

pub fn postfix_search<C, M>( &self, query: impl AsRef<[Label]> ) -> PostfixIter<'_, Label, Value, C, M>

where C: TryFromIterator<Label, M>, Label: Clone,

Return the postfixes and values of all entries that match query.

pub fn iter<C, M>(&self) -> PostfixIter<'_, Label, Value, C, M>

where C: TryFromIterator<Label, M>, Label: Clone,

Returns an iterator across all keys in the trie.

Examples

In the following example we illustrate how to iterate over all keys in the trie. Note that the order of the keys is not guaranteed, as they will be returned in lexicographical order.

use trie_rs::map::Trie;
let trie = Trie::from_iter([("a", 0), ("app", 1), ("apple", 2), ("better", 3), ("application", 4)]);
let results: Vec<(String, &u8)> = trie.iter().collect();
assert_eq!(results, [("a".to_string(), &0u8), ("app".to_string(), &1u8), ("apple".to_string(), &2u8), ("application".to_string(), &4u8), ("better".to_string(), &3u8)]);

pub fn common_prefix_search<C, M>( &self, query: impl AsRef<[Label]> ) -> PrefixIter<'_, Label, Value, C, M>

where C: TryFromIterator<Label, M>, Label: Clone,

Return the common prefixes of query.

pub fn longest_prefix<C, M>(&self, query: impl AsRef<[Label]>) -> Option<C>

where C: TryFromIterator<Label, M>, Label: Clone,

Return the longest shared prefix or terminal of query.

Trait Implementations

impl<Label: Clone, Value: Clone> Clone for Trie<Label, Value>

fn clone(&self) -> Trie<Label, Value>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Label: Debug, Value: Debug> Debug for Trie<Label, Value>

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

Formats the value using the given formatter.

impl<Label, Value, C> FromIterator<(C, Value)> for Trie<Label, Value>

where C: AsRef<[Label]>, Label: Ord + Clone,

fn from_iter<T>(iter: T) -> Self

where Self: Sized, T: IntoIterator<Item = (C, Value)>,

Creates a value from an iterator.