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> AsyncKeyValue for Namespaced<'a, K>

where K: AsyncKeyValue,

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

where Self: 'async_trait, 'life0: 'async_trait,

Executes a single KeyOperation.

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

The current namespace.

fn with_key_namespace(&self, namespace: &str) -> Namespaced<'_, Self>

where Self: 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<'a, S: Into<String>, V: Serialize + Send + Sync>( &'a self, key: S, value: &'a V ) -> AsyncBuilder<'a, Self, V>

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<'a, S: Into<String>>( &'a self, key: S, bytes: &'a [u8] ) -> AsyncBuilder<'a, Self, ()>

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: Into<String>, V: Into<Numeric>>( &self, key: S, value: V ) -> AsyncBuilder<'_, Self, ()>

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: Into<String> + Send + Sync, V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync>( &self, key: S, value: V ) -> AsyncBuilder<'_, Self, V>

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: Into<String> + Send + Sync, V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync>( &self, key: S, value: V ) -> AsyncBuilder<'_, Self, V>

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: Into<String>>(&self, key: S) -> AsyncBuilder<'_, Self>

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>>

where S: 'async_trait + Into<String> + Send, Self: 'async_trait, 'life0: 'async_trait,

Deletes the value stored at key.

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

where K: KeyValue,

fn execute_key_operation(&self, op: KeyOperation) -> Result<Output, Error>

Executes a single KeyOperation.

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

The current namespace.

fn with_key_namespace(&self, namespace: &str) -> Namespaced<'_, Self>

where Self: 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<'a, S: Into<String>, V: Serialize + Send + Sync>( &'a self, key: S, value: &'a V ) -> Builder<'a, Self, V>

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<'a, S: Into<String>>( &'a self, key: S, bytes: &'a [u8] ) -> Builder<'a, Self, ()>

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: Into<String>, V: Into<Numeric>>( &self, key: S, value: V ) -> Builder<'_, Self, ()>

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: Into<String> + Send + Sync, V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync>( &self, key: S, value: V ) -> Builder<'_, Self, V>

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: Into<String> + Send + Sync, V: Into<Numeric> + TryFrom<Numeric, Error = IncompatibleTypeError> + Send + Sync>( &self, key: S, value: V ) -> Builder<'_, Self, V>

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: Into<String>>(&self, key: S) -> Builder<'_, Self>

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<S: Into<String> + Send>(&self, key: S) -> Result<KeyStatus, Error>

Deletes the value stored at key.