Struct redb::MultimapTable

pub struct MultimapTable<'db, 'txn, K: RedbKey + 'static, V: RedbKey + 'static> { /* private fields */ }

A multimap table

Multimap tables may have multiple values associated with each key

Implementations

impl<'db, 'txn, K: RedbKey + 'static, V: RedbKey + 'static> MultimapTable<'db, 'txn, K, V>

pub fn insert<'a>(
&mut self,
key: impl Borrow<K::SelfType<'a>>,
value: impl Borrow<V::SelfType<'a>>
) -> Result<bool, Error>where
K: 'a,
V: 'a,

Add the given value to the mapping of the key

Returns true if the key-value pair was present

pub fn remove<'a>(
&mut self,
key: impl Borrow<K::SelfType<'a>>,
value: impl Borrow<V::SelfType<'a>>
) -> Result<bool, Error>where
K: 'a,
V: 'a,

Removes the given key-value pair

Returns true if the key-value pair was present

pub fn remove_all<'a>(
&mut self,
key: impl Borrow<K::SelfType<'a>>
) -> Result<MultimapValueIter<'_, V>, Error>where
K: 'a,

Removes all values for the given key

Returns an iterator over the removed values. Values are in ascending order.

Trait Implementations

impl<'db, 'txn, K: RedbKey + 'static, V: RedbKey + 'static> Drop for MultimapTable<'db, 'txn, K, V>

fn drop(&mut self)

Executes the destructor for this type.

impl<'db, 'txn, K: RedbKey + 'static, V: RedbKey + 'static> ReadableMultimapTable<K, V> for MultimapTable<'db, 'txn, K, V>

fn get<'a>(
&'a self,
key: impl Borrow<K::SelfType<'a>>
) -> Result<MultimapValueIter<'a, V>, Error>

Returns an iterator over all values for the given key. Values are in ascending order.

fn range<'a: 'b, 'b, KR>(
&'a self,
range: impl RangeBounds<KR> + 'b
) -> Result<MultimapRangeIter<'a, K, V>, Error>where
K: 'a,
KR: Borrow<K::SelfType<'b>> + 'b,

Returns a double-ended iterator over a range of elements in the table

fn len(&self) -> Result<usize, Error>

Returns the number of key-value pairs in the table

fn is_empty(&self) -> Result<bool, Error>

Returns true if the table is empty

fn iter(&self) -> Result<MultimapRangeIter<'_, K, V>, Error>

Returns an double-ended iterator over all elements in the table. Values are in ascending order.