Skip to main content

InMemoryIdempotencyStore

Struct InMemoryIdempotencyStore 

Source
pub struct InMemoryIdempotencyStore<T> { /* private fields */ }
Expand description

A process-local store of completed results, one Mutex wide.

§Example

use std::num::NonZeroUsize;

use protocol_droid::adapters::secondary::idempotency::InMemoryIdempotencyStore;
use protocol_droid::application::idempotency::IdempotencyStore;
use protocol_droid::domain::idempotency::{Claim, IdempotencyKey};

let store = InMemoryIdempotencyStore::with_capacity(NonZeroUsize::MIN);
let key = IdempotencyKey::new("req-1");

let first = store.claim(&key)?;
assert!(first.is_execution_mine());
let token = first.token().ok_or("claimed without a token")?;
store.complete(token, "charged once")?;

// The client retries because the connection dropped. It gets the recorded
// result and no second charge.
let replay = store.claim(&key)?;
// `matches!` on a `&replay` binds `result` as `&&str`, so the recorded
// value is two derefs in.
assert!(matches!(&replay, Claim::Completed(result) if **result == *"charged once"));

Implementations§

Source§

impl<T> InMemoryIdempotencyStore<T>

Source

pub fn with_capacity(capacity: NonZeroUsize) -> Self

A store holding at most capacity keys.

Bounded because the keys are peer-chosen; see CompletedResults::with_capacity.

Source

pub fn capacity(&self) -> Result<usize, IdempotencyError>

The ceiling, in keys.

Takes the lock, so a poisoned store reports the error rather than a made-up number.

§Errors

IdempotencyError::Unavailable when the lock is poisoned.

Source

pub fn len(&self) -> Result<usize, IdempotencyError>

How many keys are held, including claims that are still in flight.

§Errors

IdempotencyError::Unavailable when the lock is poisoned.

Source

pub fn is_empty(&self) -> Result<bool, IdempotencyError>

Whether nothing is held.

§Errors

IdempotencyError::Unavailable when the lock is poisoned.

Trait Implementations§

Source§

impl<T: Debug> Debug for InMemoryIdempotencyStore<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T> Default for InMemoryIdempotencyStore<T>

Source§

fn default() -> Self

A store of default_capacity keys.

Source§

impl<T: Clone + Send + Sync> IdempotencyStore for InMemoryIdempotencyStore<T>

Source§

type Result = T

What a completed side effect produced. The adapter’s own result type — an IrResult for a tool call, a transport payload for a bridge forward.
Source§

fn claim(&self, key: &IdempotencyKey) -> Result<Claim<T>, IdempotencyError>

Takes ownership of key, or reports that it is already spoken for. Read more
Source§

fn complete( &self, token: &ClaimToken, result: T, ) -> Result<(), IdempotencyError>

Records the result of a claim the caller owns. Read more
Source§

fn abandon(&self, token: &ClaimToken) -> Result<(), IdempotencyError>

Releases a claim whose execution did not produce a result. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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