Skip to main content

Trie

Struct Trie 

Source
pub struct Trie<V> { /* private fields */ }
Expand description

A trie (prefix tree) data structure

Generic over the value type V. If no value is needed, use ().

§Example

use polyglot_sql::trie::{Trie, TrieResult};

let mut trie = Trie::new();
trie.insert("cat", 1);
trie.insert("car", 2);

assert_eq!(trie.in_trie("cat"), (TrieResult::Exists, Some(&1)));
assert_eq!(trie.in_trie("ca").0, TrieResult::Prefix);
assert_eq!(trie.in_trie("dog").0, TrieResult::Failed);

Implementations§

Source§

impl<V> Trie<V>

Source

pub fn new() -> Self

Create a new empty trie

Source

pub fn insert(&mut self, key: &str, value: V)

Insert a key-value pair into the trie

§Arguments
  • key - The key to insert (a string slice)
  • value - The value to associate with the key
Source

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

Get the value associated with a key

Returns None if the key doesn’t exist or only exists as a prefix.

Source

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

Check if a key exists in the trie

Returns a tuple of (TrieResult, Option<&V>) where:

  • TrieResult::Failed - key not found
  • TrieResult::Prefix - key is a prefix of an existing key
  • TrieResult::Exists - key exists in trie

When the result is Exists, the Option will contain the value.

Source

pub fn in_trie_char(&self, ch: char) -> (TrieResult, Option<&Trie<V>>)

Check if a key exists in the trie, following one character at a time

This is useful for streaming/incremental matching. Returns:

  • TrieResult::Failed - character not found from current position
  • TrieResult::Prefix - character found, but not at end of a word
  • TrieResult::Exists - character found and at end of a word

Also returns the subtrie at this position (if any).

Source

pub fn get_child(&self, ch: char) -> Option<&Trie<V>>

Get the subtrie for a given character

Source

pub fn has_value(&self) -> bool

Check if this node has a value (is a complete word)

Source

pub fn value(&self) -> Option<&V>

Get the value at this node

Source

pub fn is_empty(&self) -> bool

Check if the trie is empty

Source

pub fn keys(&self) -> Vec<String>

Get all keys in the trie

Trait Implementations§

Source§

impl<V: Clone> Clone for Trie<V>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<V: Debug> Debug for Trie<V>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<V> Default for Trie<V>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<V> Freeze for Trie<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for Trie<V>
where V: RefUnwindSafe,

§

impl<V> Send for Trie<V>
where V: Send,

§

impl<V> Sync for Trie<V>
where V: Sync,

§

impl<V> Unpin for Trie<V>
where V: Unpin,

§

impl<V> UnwindSafe for Trie<V>
where V: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.