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

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

Trait Implementations§

source§

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

source§

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.
source§

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

The current namespace.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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

source§

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

Executes a single KeyOperation.
source§

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

The current namespace.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

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.
source§

fn delete_key<S: Into<String> + Send>(&self, key: S) -> Result<KeyStatus, Error>

Deletes the value stored at key.

Auto Trait Implementations§

§

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

§

impl<'a, K> Send for Namespaced<'a, K>
where K: Sync,

§

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

§

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

§

impl<'a, K> UnwindSafe for Namespaced<'a, K>
where K: RefUnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more