Lines
89.71 %
Functions
79.4 %
Branches
100 %
use std::ops::Add;
use std::time::{Duration, SystemTime};
use futures::{Future, FutureExt};
use serde::{Deserialize, Serialize};
use super::{
BuilderState, Command, KeyCheck, KeyOperation, KeyStatus, KeyValue, Output, PendingValue,
Timestamp,
};
use crate::keyvalue::{AsyncKeyValue, SetCommand, Value};
use crate::Error;
/// Builder for a [`Command::Set`] key-value operation.
#[must_use = "the key-value operation is not performed until execute() is called"]
pub struct Builder<'a, KeyValue, V> {
kv: &'a KeyValue,
namespace: Option<String>,
key: String,
value: PendingValue<'a, V>,
expiration: Option<Timestamp>,
keep_existing_expiration: bool,
check: Option<KeyCheck>,
}
impl<'a, K, V> Builder<'a, K, V>
where
K: KeyValue,
V: Serialize + Send + Sync,
{
pub(crate) const fn new(
kv: &'a K,
) -> Self {
Self {
key,
value,
kv,
namespace,
expiration: None,
keep_existing_expiration: false,
check: None,
/// Set this key to expire after `duration` from now.
pub fn expire_in(mut self, duration: Duration) -> Self {
// TODO consider using checked_add here and making it return an error.
self.expiration = Some(Timestamp::from(SystemTime::now().add(duration)));
self
/// Set this key to expire at the provided `time`.
pub fn expire_at(mut self, time: SystemTime) -> Self {
self.expiration = Some(Timestamp::from(time));
/// If the key already exists, do not update the currently set expiration.
pub const fn keep_existing_expiration(mut self) -> Self {
self.keep_existing_expiration = true;
/// Only set the value if this key already exists.
pub const fn only_if_exists(mut self) -> Self {
self.check = Some(KeyCheck::OnlyIfPresent);
/// Only set the value if this key isn't present.
pub const fn only_if_vacant(mut self) -> Self {
self.check = Some(KeyCheck::OnlyIfVacant);
/// Executes the Set operation, requesting the previous value be returned.
/// If no change is made, None will be returned.
#[allow(clippy::missing_panics_doc)]
pub fn returning_previous(self) -> Result<Option<Value>, Error> {
let Self {
expiration,
keep_existing_expiration,
check,
} = self;
let result = kv.execute_key_operation(KeyOperation {
command: Command::Set(SetCommand {
value: value.prepare()?,
return_previous_value: true,
}),
})?;
match result {
Output::Value(value) => Ok(value),
Output::Status(KeyStatus::NotChanged) => Ok(None),
Output::Status(_) => unreachable!("Unexpected output from Set"),
pub fn returning_previous_as<OtherV: for<'de> Deserialize<'de>>(
self,
) -> Result<Option<OtherV>, Error> {
self.returning_previous()?
.map(|value| value.deserialize())
.transpose()
/// Executes the operation using the configured options.
pub fn execute(self) -> Result<KeyStatus, Error> {
return_previous_value: false,
if let Output::Status(status) = result {
Ok(status)
} else {
unreachable!("Unexpected output from Set")
#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct AsyncBuilder<'a, KeyValue, V> {
state: BuilderState<'a, Options<'a, KeyValue, V>, Result<KeyStatus, Error>>,
struct Options<'a, KeyValue, V> {
impl<'a, K, V> AsyncBuilder<'a, K, V>
K: AsyncKeyValue,
state: BuilderState::Pending(Some(Options {
})),
fn options(&mut self) -> &mut Options<'a, K, V> {
if let BuilderState::Pending(Some(options)) = &mut self.state {
options
panic!("Attempted to use after retrieving the result")
self.options().expiration = Some(Timestamp::from(SystemTime::now().add(duration)));
self.options().expiration = Some(Timestamp::from(time));
pub fn keep_existing_expiration(mut self) -> Self {
self.options().keep_existing_expiration = true;
pub fn only_if_exists(mut self) -> Self {
self.options().check = Some(KeyCheck::OnlyIfPresent);
pub fn only_if_vacant(mut self) -> Self {
self.options().check = Some(KeyCheck::OnlyIfVacant);
pub async fn returning_previous(self) -> Result<Option<Value>, Error> {
if let BuilderState::Pending(Some(builder)) = self.state {
let Options {
} = builder;
let result = kv
.execute_key_operation(KeyOperation {
})
.await?;
panic!("Using future after it's been executed")
pub async fn returning_previous_as<OtherV: for<'de> Deserialize<'de>>(
self.returning_previous()
.await?
impl<'a, K, V> Future for AsyncBuilder<'a, K, V>
type Output = Result<KeyStatus, Error>;
fn poll(
mut self: std::pin::Pin<&mut Self>,
cx: &mut std::task::Context<'_>,
) -> std::task::Poll<Self::Output> {
match &mut self.state {
BuilderState::Executing(future) => future.as_mut().poll(cx),
BuilderState::Pending(builder) => {
} = builder.take().expect("expected builder to have options");
let future = async move {
.boxed();
self.state = BuilderState::Executing(future);
self.poll(cx)