Struct trie_rs::Trie

pub struct Trie<Label>(pub Trie<Label, ()>);

A trie for sequences of the type Label.

Tuple Fields

0: Trie<Label, ()>

Implementations

impl<Label: Ord> Trie<Label>

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

Return true if query is an exact match.

Arguments

• query - The query to search for.

Examples

In the following example we illustrate how to query an exact match.

use trie_rs::Trie;

let trie = Trie::from_iter(["a", "app", "apple", "better", "application"]);

assert!(trie.exact_match("application"));
assert!(trie.exact_match("app"));
assert!(!trie.exact_match("appla"));

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

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

Return the common prefixes of query.

Arguments

• query - The query to search for.

Examples

In the following example we illustrate how to query the common prefixes of a query string.

use trie_rs::Trie;

let trie = Trie::from_iter(["a", "app", "apple", "better", "application"]);

let results: Vec<String> = trie.common_prefix_search("application").collect();

assert_eq!(results, vec!["a", "app", "application"]);

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

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

Return all entries that match query.

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

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

Return the postfixes of all entries that match query.

Arguments

• query - The query to search for.

Examples

In the following example we illustrate how to query the postfixes of a query string.

use trie_rs::Trie;

let trie = Trie::from_iter(["a", "app", "apple", "better", "application"]);

let results: Vec<String> = trie.postfix_search("application").collect();

assert!(results.is_empty());

let results: Vec<String> = trie.postfix_search("app").collect();

assert_eq!(results, vec!["le", "lication"]);

pub fn iter<C, M>(&self) -> Keys<PostfixIter<'_, Label, (), 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::Trie;

let trie = Trie::from_iter(["a", "app", "apple", "better", "application"]);

let results: Vec<String> = trie.iter().collect();

assert_eq!(results, vec!["a", "app", "apple", "application", "better"]);

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

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 longest_prefix<C, M>(&self, query: impl AsRef<[Label]>) -> Option<C>

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

Return the longest shared prefix of query.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<Label, C> FromIterator<C> for Trie<Label>

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

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

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

Creates a value from an iterator.