Struct Trie 

pub struct Trie { /* private fields */ }

Standard Trie implementation using arena allocation. All nodes are stored in a Vec<Node>; children are indices into that vec.

Implementations

impl Trie

pub fn new() -> Self

pub fn node_count(&self) -> usize

Total number of nodes (including root).

pub fn word_count(&self) -> usize

Number of distinct words stored.

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

Returns true if word exists in the trie.

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

Returns true if prefix is a prefix of any word in the trie.

pub fn add(&mut self, word: &str, count: usize) -> Result<(), LexError>

Add a word with an optional count (default 1).

pub fn add_all<I: IntoIterator<Item = String>>( &mut self, words: I, ) -> Result<(), LexError>

Add all words from an iterator.

pub fn add_from_file(&mut self, path: &str) -> Result<(), LexError>

Add all words from a file (one word per line).

pub fn search(&self, pattern: &str) -> Result<Vec<String>, LexError>

Return all words matching the wildcard pattern. ? matches exactly one character; * matches zero or more.

pub fn search_with_count( &self, pattern: &str, ) -> Result<Vec<(String, usize)>, LexError>

Like search but also returns word counts.

pub fn search_with_prefix(&self, prefix: &str) -> Vec<String>

Return all words with the given prefix.

pub fn search_with_prefix_count(&self, prefix: &str) -> Vec<(String, usize)>

Like search_with_prefix but also returns counts.

pub fn search_within_distance(&self, word: &str, dist: usize) -> Vec<String>

Return all words within Levenshtein dist of word.

pub fn search_within_distance_count( &self, word: &str, dist: usize, ) -> Vec<(String, usize)>

Like search_within_distance but also returns counts.

Trait Implementations

impl Default for Trie

fn default() -> Self

Returns the “default value” for a type.