Struct IncSearch

pub struct IncSearch<'a, Label, Value> { /* private fields */ }

An incremental search of the trie.

Implementations

impl<'a, Label: Ord, Value> IncSearch<'a, Label, Value>

pub fn new(trie: &'a Trie<Label, Value>) -> Self

Create a new incremental search for a trie.

pub fn resume(trie: &'a Trie<Label, Value>, position: Position) -> Self

Resume an incremental search at a particular point.

use trie_rs::{Trie, inc_search::{Answer, IncSearch}};
use louds_rs::LoudsNodeNum;

let trie: Trie<u8> = ["hello", "bye"].into_iter().collect();
let mut inc_search = trie.inc_search();

assert_eq!(inc_search.query_until("he"), Ok(Answer::Prefix));
let position = LoudsNodeNum::from(inc_search);

// inc_search is dropped.
let mut inc_search2 = IncSearch::resume(&trie.0, position);
assert_eq!(inc_search2.query_until("llo"), Ok(Answer::Match));

pub fn peek(&self, chr: &Label) -> Option<Answer>

Query but do not change the node we’re looking at on the trie.

pub fn query(&mut self, chr: &Label) -> Option<Answer>

Query the trie and go to node if there is a match.

pub fn query_until( &mut self, query: impl AsRef<[Label]>, ) -> Result<Answer, usize>

Query the trie with a sequence. Will return Err(index of query) on first failure to match.

pub fn value(&self) -> Option<&'a Value>

Return the value at current node. There should be one for any node where answer.is_match() is true.

pub fn goto_longest_prefix(&mut self) -> Result<usize, usize>

Go to the longest shared prefix.

pub fn prefix<C, M>(&self) -> C

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

Return the current prefix for this search.

pub fn prefix_len(&self) -> usize

Returne the length of the current prefix for this search.

pub fn reset(&mut self)

Reset the query.

Trait Implementations

impl<'a, Label: Clone, Value: Clone> Clone for IncSearch<'a, Label, Value>

fn clone(&self) -> IncSearch<'a, Label, Value>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Label: Debug, Value: Debug> Debug for IncSearch<'a, Label, Value>

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

Formats the value using the given formatter.

impl<'a, L, V> From<IncSearch<'a, L, V>> for Position

Retrieve the position the search is on. Useful for hanging on to a search without having to fight the borrow checker because its borrowing a trie.

fn from(inc_search: IncSearch<'a, L, V>) -> Self

Converts to this type from the input type.