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>)>, Error>

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

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

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

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

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

pub fn drain_filter<'a: 'b, 'b, KR, F: for<'f> Fn(K::SelfType<'f>, V::SelfType<'f>) -> bool>(
&'a mut self,
range: impl RangeBounds<KR> + Clone + 'b,
predicate: F
) -> Result<DrainFilter<'a, K, V, F>, Error>where
K: 'a,
KR: Borrow<K::SelfType<'b>> + Clone + 'b,

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>>, Error>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 insert_reserve<'a>(
&mut self,
key: impl Borrow<K::SelfType<'a>>,
value_length: usize
) -> Result<AccessGuardMut<'_, K, &[u8]>, Error>where
K: 'a,

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

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

Removes the given key

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

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>>, Error>where
K: 'a,

Returns the value corresponding to the given key

fn range<'a: 'b, 'b, KR>(
&'a self,
range: impl RangeBounds<KR> + 'b
) -> Result<RangeIter<'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 entries in the table

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

Returns true if the table is empty

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

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