Struct Trie

pub struct Trie<K, V>
where
    K: Clone + PartialEq,
    V: Clone,
{ /* private fields */ }

A singly initialised Trie mapping sequences to a value

NOTE: It is not permitted for values to be mapped to a key that is a prefix of another key also existing in the same Try.

There are convenience methods provided for Trie<char, V> for when &str values are used as keys.

Implementations

impl<K, V> Trie<K, V>

where K: Clone + PartialEq, V: Clone,

pub fn from_pairs(pairs: Vec<(Vec<K>, V)>) -> Self

Will panic if there are any key collisions or if there are any sequences that nest under a prefix that is already required to hold a value

pub fn set_default(&mut self, default: DefaultMapping<K, V>)

Set the default handler for unmatched single element keys

pub fn get(&self, key: &[K]) -> QueryResult<V>

Query this Try for a given key or key prefix.

If the key maps to a leaf then the value is returned, if it maps to a sub-trie then Partial is returned to denote that the given key is a parent of one or more values. If the key is not found within the Try then Missing is returned.

pub fn get_exact(&self, key: &[K]) -> Option<V>

Query this Try for a given key or key prefix requiring the key to match exactly.

If the key maps to a leaf then the Some(value) is returned, otherwise None.

pub fn candidates(&self, key: &[K]) -> Vec<Vec<K>>

Find all candidate keys with the given key as a prefix (up to and including the given prefix itself).

pub fn len(&self) -> usize

The number of leaf nodes in this Try

pub fn is_empty(&self) -> bool

The number of leaf nodes in this Try

pub fn contains_key_or_prefix(&self, key: &[K]) -> bool

Wether the given key is present in this Trie either as a full key or a partial prefix to multiple keys.

impl<V> Trie<char, V>

where V: Clone,

pub fn from_str_keys(pairs: Vec<(&str, V)>) -> Self

Construct a new Trie with char internal keys from the given string keys.

pub fn get_str(&self, key: &str) -> QueryResult<V>

Query this Trie using a string key.

Both full and partial matches are possible.

pub fn get_str_exact(&self, key: &str) -> Option<V>

Query this Trie using a string key.

Only fll matches will be returned.

pub fn candidate_strings(&self, key: &str) -> Vec<String>

Show all partial and full matches for the given key.

Trait Implementations

impl<K, V> Clone for Trie<K, V>

where K: Clone + PartialEq + Clone, V: Clone + Clone,

fn clone(&self) -> Trie<K, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V> Debug for Trie<K, V>

where K: Clone + PartialEq + Debug, V: Clone + Debug,

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

Formats the value using the given formatter.

impl<K, V> PartialEq for Trie<K, V>

where K: Clone + PartialEq + PartialEq, V: Clone + PartialEq,

fn eq(&self, other: &Trie<K, V>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> Eq for Trie<K, V>

where K: Clone + PartialEq + Eq, V: Clone + Eq,

impl<K, V> StructuralPartialEq for Trie<K, V>

where K: Clone + PartialEq, V: Clone,