Struct Index 

pub struct Index<T: Translator, V: Eq> { /* private fields */ }

A memory-efficient index that maps translated keys to arbitrary values.

Implementations

impl<T: Translator, V: Eq> Index<T, V>

pub fn init(ctx: impl Metrics, tr: T) -> Self

Create a new index with the given translator.

pub fn keys(&self) -> usize

Returns the number of translated keys in the index.

pub fn get(&self, key: &[u8]) -> impl Iterator<Item = &V>

Returns an iterator over all values associated with a translated key.

pub fn get_mut(&mut self, key: &[u8]) -> Option<Cursor<'_, T, V>>

Provides mutable access to the values associated with a translated key, if the key exists.

pub fn get_mut_or_insert( &mut self, key: &[u8], v: V, ) -> Option<Cursor<'_, T, V>>

Provides mutable access to the values associated with a translated key (if the key exists), otherwise inserts a new value and returns None.

pub fn remove(&mut self, key: &[u8])

Remove all values at the given translated key.

pub fn insert(&mut self, key: &[u8], v: V)

Insert a value at the given translated key.

pub fn insert_and_prune(&mut self, key: &[u8], v: V, prune: impl Fn(&V) -> bool)

Insert a value at the given translated key, and prune any values that are no longer valid.

If the value is prunable, it will not be inserted.

pub fn prune(&mut self, key: &[u8], prune: impl Fn(&V) -> bool)

Remove all values associated with a translated key that match the prune predicate.

Trait Implementations

impl<T: Translator, V: Eq> Drop for Index<T, V>

fn drop(&mut self)

To avoid stack overflow on keys with many collisions, we implement an iterative drop (in lieu of Rust’s default recursive drop).