Struct MultimapTable

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

A multimap table

Multimap tables may have multiple values associated with each key

Implementations

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

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

Add the given value to the mapping of the key

Returns true if the key-value pair was present

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

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<MultimapValue<'_, V>>

Removes all values for the given key

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl<K: Key + 'static, V: Key + 'static> MultimapTableHandle for MultimapTable<'_, K, V>

fn name(&self) -> &str

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

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

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

fn range<'a, KR>( &self, range: impl RangeBounds<KR> + 'a, ) -> Result<MultimapRange<'_, K, V>>

where KR: Borrow<K::SelfType<'a>> + 'a,

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

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

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

impl<'txn, K: Key + 'static, V: Key + 'static> ReadableTableMetadata for MultimapTable<'txn, K, V>

fn len(&self) -> Result<u64>

Returns the number of key-value pairs in the table

fn stats(&self) -> Result<TableStats>

Retrieves information about storage usage for the table

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

Returns true if the table is empty

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 160 bytes