Struct bonsaidb::core::keyvalue::set::Builder

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

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

Implementations

impl<'a, K, V> Builder<'a, K, V>

where K: KeyValue, V: Serialize + Send + Sync,

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

Set this key to expire after duration from now.

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

Set this key to expire at the provided time.

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

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

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

Only set the value if this key already exists.

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

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

pub fn returning_previous(self) -> Result<Option<Value>, Error>

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

pub fn returning_previous_as<OtherV>(self) -> 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.

pub fn execute(self) -> Result<KeyStatus, Error>

Executes the operation using the configured options.