Struct Index 

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

A memory-efficient index that uses an unordered map internally to map translated keys to arbitrary values.

Implementations

impl<T: Translator, V: Eq + Send + Sync> Index<T, V>

pub fn new(ctx: impl Metrics, translator: T) -> Self

Create a new index with the given translator and metrics registry.

Trait Implementations

impl<T: Translator, V: Eq + Send + Sync> 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).

impl<T: Translator, V: Eq + Send + Sync> Unordered for Index<T, V>

type Value = V

The type of values the index stores.

type Cursor<'a> = Cursor<'a, <T as Translator>::Key, V> where Self: 'a

The type of cursor returned by this index to iterate over values with conflicting keys.

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

where V: 'a,

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

fn get_mut<'a>(&'a mut self, key: &[u8]) -> Option<Self::Cursor<'a>>

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

fn get_mut_or_insert<'a>( &'a mut self, key: &[u8], value: V, ) -> Option<Self::Cursor<'a>>

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

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

Inserts a new value at the current position.

fn insert_and_prune( &mut self, key: &[u8], value: V, predicate: impl Fn(&V) -> bool, )

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

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

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

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

Remove all values associated with a translated key.