Struct redb::MultimapTable

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

A multimap table

Multimap tables may have multiple values associated with each key

Implementations

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

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

Add the given value to the mapping of the key

Returns true if the key-value pair was present

pub fn remove(
    &mut self,
    key: &K::RefBaseType<'_>,
    value: &V::RefBaseType<'_>
) -> Result<bool, Error>

Removes the given key-value pair

Returns true if the key-value pair was present

pub fn remove_all(
    &mut self,
    key: &K::RefBaseType<'_>
) -> Result<MultimapValueIter<'_, V>, Error>

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 + ?Sized, V: RedbKey + ?Sized> Drop for MultimapTable<'db, 'txn, K, V>

fn drop(&mut self)

Executes the destructor for this type.

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

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

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

fn range<'a, T: RangeBounds<&'a K::RefBaseType<'a>> + 'a>(
    &'a self,
    range: T
) -> Result<MultimapRangeIter<'a, K, V>, Error>

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.