Struct PrefixTrie

pub struct PrefixTrie { /* private fields */ }

A prefix trie implementation that stores its nodes in TiKV.

The trie uses a prefix string to namespace its nodes in the TiKV keyspace, preventing conflicts with other data stored in the same TiKV cluster.

Try to not be comedic and nameclash with structures with a Store derive, as unexpected things might happen.

Implementations

impl PrefixTrie

pub fn new(prefix: impl Into<String>) -> Self

Creates a new prefix trie with the given namespace prefix.

Examples

let trie = PrefixTrie::new("my_namespace");

pub async fn insert( &self, txn: &mut Transaction, key: &str, ) -> Result<(), TikvError>

Inserts a key into the trie.

Empty strings are not allowed as keys.

Errors

Returns an error if the key is empty or if the TiKV operation fails.

pub async fn get( &self, txn: &mut Transaction, key: &str, ) -> Result<Option<String>, TikvError>

Retrieves a key from the trie.

Returns None if the key doesn’t exist.

pub async fn find_by_prefix( &self, txn: &mut Transaction, prefix: &str, ) -> Result<Vec<String>, TikvError>

Finds all keys in the trie that start with the given prefix.

Returns a vector of matching keys in no particular order.

pub async fn all(&self, txn: &mut Transaction) -> Result<Vec<String>, TikvError>

Returns a vector of all keys stored in the trie.

The keys are returned in no particular order.

pub async fn remove( &self, txn: &mut Transaction, key: &str, ) -> Result<(), TikvError>

Removes a key from the trie.

If the key doesn’t exist, this operation is a no-op. The operation also cleans up any nodes that become unused after the removal.

Trait Implementations

impl Clone for PrefixTrie

fn clone(&self) -> PrefixTrie

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PrefixTrie

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

Formats the value using the given formatter.