Struct redb::Table

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

A table containing key-value mappings

Implementations

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

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

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

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

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

pub fn drain<'a, KR>( &mut self, range: impl RangeBounds<KR> + 'a ) -> Result<Drain<'_, K, V>, StorageError>where K: 'a, KR: Borrow<K::SelfType<'a>> + 'a,

Removes the specified range and returns the removed entries in an iterator

pub fn drain_filter<'a, KR, F: for<'f> Fn(K::SelfType<'f>, V::SelfType<'f>) -> bool>( &mut self, range: impl RangeBounds<KR> + 'a, predicate: F ) -> Result<DrainFilter<'_, K, V, F>, StorageError>where K: 'a, 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 removed and returned in an iterator

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

Insert mapping of the given key to the given value

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

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

Removes the given key

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

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

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

Reserve space to insert a key-value pair The returned reference will have length equal to value_length

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl<'db, 'txn, K: RedbKey + 'static, V: RedbValue + 'static> ReadableTable<K, V> for Table<'db, 'txn, K, V>

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

Returns the value corresponding to the given key

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

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

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

Returns the number of entries in the table

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

Returns true if the table is empty

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

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