Struct redb::Table

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

A table containing key-value mappings

Implementations

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

pub fn pop_first( &mut self ) -> Result<Option<(AccessGuard<'_, K>, AccessGuard<'_, V>)>>

Removes and returns the first key-value pair in the table

pub fn pop_last( &mut self ) -> Result<Option<(AccessGuard<'_, K>, AccessGuard<'_, V>)>>

Removes and returns the last key-value pair in the table

pub fn extract_if<F: for<'f> FnMut(K::SelfType<'f>, V::SelfType<'f>) -> bool>( &mut self, predicate: F ) -> Result<ExtractIf<'_, K, V, F>>

Applies predicate to all key-value pairs. All entries for which predicate evaluates to true are returned in an iterator, and those which are read from the iterator are removed

Note: values not read from the iterator will not be removed

pub fn extract_from_if<'a, KR, F: for<'f> FnMut(K::SelfType<'f>, V::SelfType<'f>) -> bool>( &mut self, range: impl RangeBounds<KR> + 'a, predicate: F ) -> Result<ExtractIf<'_, K, V, F>>

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

Applies predicate to all key-value pairs in the specified range. All entries for which predicate evaluates to true are returned in an iterator, and those which are read from the iterator are removed

Note: values not read from the iterator will not be removed

pub fn retain<F: for<'f> FnMut(K::SelfType<'f>, V::SelfType<'f>) -> bool>( &mut self, predicate: F ) -> Result

Applies predicate to all key-value pairs. All entries for which predicate evaluates to false are removed.

pub fn retain_in<'a, KR, F: for<'f> FnMut(K::SelfType<'f>, V::SelfType<'f>) -> bool>( &mut self, range: impl RangeBounds<KR> + 'a, predicate: F ) -> Result

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

Applies predicate to all key-value pairs in the range start..end. All entries for which predicate evaluates to false are removed.

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

Insert mapping of the given key to the given value

If key is already present it is replaced

Returns the old value, if the key was present in the table, otherwise None is returned

pub fn remove<'a>( &mut self, key: impl Borrow<K::SelfType<'a>> ) -> Result<Option<AccessGuard<'_, V>>>

Removes the given key

Returns the old value, if the key was present in the table

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

pub fn insert_reserve<'a>( &mut self, key: impl Borrow<K::SelfType<'a>>, value_length: u32 ) -> Result<AccessGuardMut<'_, V>>

Reserve space to insert a key-value pair

If key is already present it is replaced

The returned reference will have length equal to value_length

Trait Implementations

impl<K: Key + 'static, V: Value + 'static> Debug for Table<'_, K, V>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<'txn, K: Key + 'static, V: Value + 'static> ReadableTable<K, V> for Table<'txn, K, V>

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

Returns the value corresponding to the given key

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

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

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

fn first(&self) -> Result<Option<(AccessGuard<'_, K>, AccessGuard<'_, V>)>>

Returns the first key-value pair in the table, if it exists

fn last(&self) -> Result<Option<(AccessGuard<'_, K>, AccessGuard<'_, V>)>>

Returns the last key-value pair in the table, if it exists

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

Returns a double-ended iterator over all elements in the table

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

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

Retrieves information about storage usage for the table

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

Returns the number of entries in the table

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

Returns true if the table is empty

impl<K: Key + 'static, V: Value + 'static> TableHandle for Table<'_, K, V>

fn name(&self) -> &str