Struct Index 

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

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

Each translated key maps directly to its most recently inserted value. Conflicting values (from key collisions or repeated insertions) live in a separate overflow map, keeping the common (collision-free) case compact.

Implementations

impl<T: Translator, V: 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: Send + Sync> Factory<T> for Index<T, V>

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

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

impl<T: Translator, V: 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, OccupiedEntry<'a, <T as Translator>::Key, V>, T> 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 for the translated key.

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

Insert a value at the given translated key, and remove any values for which should_retain returns false.

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

Remove all values associated with a translated key.

fn get_many<'a, K: AsRef<[u8]>>( &'a self, keys: &[K], visit: impl FnMut(usize, &'a Self::Value), )

where Self::Value: 'a,

Visits every value associated with each key, calling visit(key_idx, value).

fn retain(&mut self, key: &[u8], should_retain: impl Fn(&Self::Value) -> bool)

Retain only the values associated with a translated key for which should_retain returns true. All other values are removed.