Struct CommandTrie 

pub struct CommandTrie<T> { /* private fields */ }

Compact, read-only radix trie produced by CommandTrieBuilder::build.

All storage lives in four boxed slices (nodes, labels, children, child_first_bytes). All query methods are non-allocating in their lookup paths; only methods that materialize keys (e.g. Iter::next) allocate.

Implementations

impl<T> CommandTrie<T>

pub fn len(&self) -> usize

Number of entries stored in the trie.

pub fn is_empty(&self) -> bool

Returns true when the trie holds no entries.

pub fn get(&self, key: &str) -> Option<&T>

Exact lookup.

pub fn contains(&self, key: &str) -> bool

Returns true when key is present in the trie.

pub fn longest_prefix_match<'a>(&self, input: &'a str) -> Option<(&'a str, &T)>

Longest stored key that is a prefix of input, with its value.

The returned &str is a slice of input; its len() is the number of bytes consumed.

pub fn contains_prefix(&self, prefix: &str) -> bool

Returns true if any stored key starts with prefix.

pub fn iter(&self) -> Iter<'_, T>

Iterator over all (key, value) pairs in alphabetical order.

Each item allocates a fresh String for the key. For hot loops prefer Self::for_each, which reuses an internal buffer.

pub fn for_each(&self, f: impl FnMut(&str, &T))

Visit every (key, value) pair in alphabetical order without allocating per match.

pub fn subtrie<'a>(&'a self, prefix: &str) -> Option<SubTrie<'a, T>>

View of the entries whose key starts with prefix.

Returns None if no entry has that prefix. Prefer this when you need to ask multiple questions about the same prefix.

pub fn completions<'a>(&'a self, prefix: &str) -> Vec<(String, &'a T)>

All (key, value) pairs whose key starts with prefix.

Allocates a Vec and a String per match; for hot paths prefer Self::for_each_completion.

pub fn count_completions(&self, prefix: &str) -> usize

Number of entries whose key starts with prefix. Allocation-free.

pub fn completion_prefix(&self, prefix: &str) -> Option<String>

Longest string s such that every key matching prefix also starts with s. Always s.starts_with(prefix); may extend past prefix when only one branch is reachable. None if no entries match.

Allocates exactly one String (the returned value).

pub fn for_each_completion(&self, prefix: &str, f: impl FnMut(&str, &T))

Visit every completion of prefix without allocating per match.

Trait Implementations

impl<T: Clone> Clone for CommandTrie<T>

fn clone(&self) -> CommandTrie<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for CommandTrie<T>

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

Formats the value using the given formatter.

impl<T> Default for CommandTrie<T>

fn default() -> Self

An empty, frozen trie (equivalent to CommandTrieBuilder::new().build()).

impl<'a, T> IntoIterator for &'a CommandTrie<T>

type Item = (String, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.