Struct bonsaidb::core::keyvalue::namespaced::Namespaced

pub struct Namespaced<'a, K> { /* private fields */ }

A namespaced key-value store. All operations performed with this will be separate from other namespaces.

Trait Implementations

impl<'a, K> KeyValue for Namespaced<'a, K> where
    K: KeyValue, 

pub fn execute_key_operation<'life0, 'async_trait>(
    &'life0 self,
    op: KeyOperation
) -> Pin<Box<dyn Future<Output = Result<Output, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Namespaced<'a, K>: 'async_trait, 

Executes a single KeyOperation.

pub fn key_namespace(&self) -> Option<&str>

The current namespace.

pub fn with_key_namespace(
    &self,
    namespace: &str
) -> Namespaced<'_, Namespaced<'a, K>> where
    Namespaced<'a, K>: Sized, 

Access this Key-Value store within a namespace. When using the returned Namespaced instance, all keys specified will be separated into their own storage designated by namespace.

fn set_key<S, V>(&'a self, key: S, value: &'a V) -> Builder<'a, Self, V> where
    S: Into<String>,
    V: Serialize + Send + Sync, 

Sets key to value. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_binary_key<S>(&'a self, key: S, bytes: &'a [u8]) -> Builder<'a, Self, ()> where
    S: Into<String>, 

Sets key to bytes. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn set_numeric_key<S, V>(&self, key: S, value: V) -> Builder<'_, Self, ()> where
    S: Into<String>,
    V: Into<Numeric>, 

Sets key to value. This stores the value as a Numeric, enabling atomic math operations to be performed on this key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Set with the options given.

fn increment_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Increments key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the increment will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn decrement_key_by<S, V>(&self, key: S, value: V) -> Builder<'_, Self, V> where
    S: Into<String> + Send + Sync,
    V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync, 

Decrements key by value. The value stored must be a Numeric, otherwise an error will be returned. The result of the decrement will be the value’s type. For example, if the stored value is currently a u64, but value is a f64, the current value will be converted to an f64, and the stored value will be an f64.

fn get_key<S>(&self, key: S) -> Builder<'_, Self> where
    S: Into<String>, 

Gets the value stored at key. This function returns a builder that is also a Future. Awaiting the builder will execute Command::Get with the options given.

fn delete_key<'life0, 'async_trait, S>(
    &'life0 self,
    key: S
) -> Pin<Box<dyn Future<Output = Result<KeyStatus, Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    S: Into<String> + Send + 'async_trait,
    Self: 'async_trait, 

Deletes the value stored at key.