Struct bonsaidb::core::keyvalue::set::AsyncBuilder

pub struct AsyncBuilder<'a, KeyValue, V> { /* private fields */ }

Builder for a Command::Set key-value operation.

Implementations

impl<'a, K, V> AsyncBuilder<'a, K, V>where K: AsyncKeyValue, V: Serialize + Send + Sync,

pub fn expire_in(self, duration: Duration) -> AsyncBuilder<'a, K, V>

Set this key to expire after duration from now.

pub fn expire_at(self, time: SystemTime) -> AsyncBuilder<'a, K, V>

Set this key to expire at the provided time.

pub fn keep_existing_expiration(self) -> AsyncBuilder<'a, K, V>

If the key already exists, do not update the currently set expiration.

pub fn only_if_exists(self) -> AsyncBuilder<'a, K, V>

Only set the value if this key already exists.

pub fn only_if_vacant(self) -> AsyncBuilder<'a, K, V>

Only set the value if this key isn’t present.

pub async fn returning_previous( self ) -> impl Future<Output = Result<Option<Value>, Error>>

Executes the Set operation, requesting the previous value be returned. If no change is made, None will be returned.

pub async fn returning_previous_as<OtherV>( self ) -> impl Future<Output = Result<Option<OtherV>, Error>>where OtherV: for<'de> Deserialize<'de>,

Executes the Set operation, requesting the previous value be returned. If no change is made, None will be returned.

Trait Implementations

impl<'a, K, V> Future for AsyncBuilder<'a, K, V>where K: AsyncKeyValue, V: Serialize + Send + Sync,

type Output = Result<KeyStatus, Error>

The type of value produced on completion.

fn poll( self: Pin<&mut AsyncBuilder<'a, K, V>>, cx: &mut Context<'_> ) -> Poll<<AsyncBuilder<'a, K, V> as Future>::Output>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.