Struct Index 

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

A partitioned index that maps translated keys to values. The first P bytes of the (untranslated) key are used to determine the partition, and the translator is used by the partition-specific indices on the key after stripping this prefix. The value of P should be small, typically 1 or 2. Anything larger than 3 will fail to compile.

Implementations

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

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, const P: usize> Unordered for Index<T, V, P>

type Value = V

The type of values the index stores.

type Cursor<'a> = <Index<T, V> as Unordered>::Cursor<'a> 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 Self::Value> + 'a

where Self::Value: '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: Self::Value, ) -> 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], value: Self::Value)

Inserts a new value at the current position.

fn insert_and_prune( &mut self, key: &[u8], value: Self::Value, predicate: impl Fn(&Self::Value) -> 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(&Self::Value) -> 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.