Struct kv::Bucket

pub struct Bucket<'a, K: Key<'a>, V: Value>(/* private fields */);

Provides typed access to the key/value store

Implementations

impl<'a, K: Key<'a>, V: Value> Bucket<'a, K, V>

pub fn contains(&self, key: &K) -> Result<bool, Error>

Returns true if the bucket contains the given key

pub fn get(&self, key: &K) -> Result<Option<V>, Error>

Get the value associated with the specified key

pub fn set(&self, key: &K, value: &V) -> Result<Option<V>, Error>

Set the value associated with the specified key to the provided value

pub fn compare_and_swap( &self, key: &K, old: Option<&V>, value: Option<&V> ) -> Result<(), Error>

Set the value associated with the specified key to the provided value, only if the existing value matches the old parameter

pub fn remove(&self, key: &K) -> Result<Option<V>, Error>

Remove the value associated with the specified key from the database

pub fn iter(&self) -> Iter<K, V>

Get an iterator over keys/values

pub fn iter_range(&self, a: &K, b: &K) -> Result<Iter<K, V>, Error>

Get an iterator over keys/values in the specified range

pub fn iter_prefix(&self, a: &K) -> Result<Iter<K, V>, Error>

Iterate over keys/values with the specified prefix

pub fn batch(&self, batch: Batch<K, V>) -> Result<(), Error>

Apply batch update

pub fn watch_prefix(&self, prefix: Option<&K>) -> Result<Watch<K, V>, Error>

Get updates when a key with the given prefix is changed

pub fn transaction<A, E: From<Error>, F: Fn(Transaction<'_, '_, K, V>) -> Result<A, TransactionError<E>>>( &self, f: F ) -> Result<A, E>

Execute a transaction

pub fn transaction2<A, T: Key<'a>, U: Value, E: From<Error>, F: Fn(Transaction<'_, '_, K, V>, Transaction<'_, '_, T, U>) -> Result<A, TransactionError<E>>>( &self, other: &Bucket<'a, T, U>, f: F ) -> Result<A, E>

Create a transaction with access to two buckets

pub fn transaction3<A, T: Key<'a>, U: Value, X: Key<'a>, Y: Value, E: From<Error>, F: Fn(Transaction<'_, '_, K, V>, Transaction<'_, '_, T, U>, Transaction<'_, '_, X, Y>) -> Result<A, TransactionError<E>>>( &self, other: &Bucket<'a, T, U>, other1: &Bucket<'a, X, Y>, f: F ) -> Result<A, E>

Create a transaction with access to three buckets

pub fn prev_key(&self, key: &K) -> Result<Option<Item<K, V>>, Error>

Get previous key and value in order, if one exists

pub fn next_key(&self, key: &K) -> Result<Option<Item<K, V>>, Error>

Get next key and value in order, if one exists

pub fn flush(&self) -> Result<usize, Error>

Flush to disk

pub async fn flush_async(&self) -> Result<usize, Error>

Flush to disk

pub fn pop_back(&self) -> Result<Option<Item<K, V>>, Error>

Remove and return the last item

pub fn pop_front(&self) -> Result<Option<Item<K, V>>, Error>

Remove and return the first item

pub fn first(&self) -> Result<Option<Item<K, V>>, Error>

Get the first item

pub fn last(&self) -> Result<Option<Item<K, V>>, Error>

Get the last item

pub fn len(&self) -> usize

Get the number of items

pub fn is_empty(&self) -> bool

Returns true when there are no items

pub fn clear(&self) -> Result<(), Error>

Remove all items

pub fn checksum(&self) -> Result<u32, Error>

CRC32 checksum of all keys and values

Trait Implementations

impl<'a, K: Clone + Key<'a>, V: Clone + Value> Clone for Bucket<'a, K, V>

fn clone(&self) -> Bucket<'a, K, V>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.