Skip to main content

IdempotencyStrategy

Enum IdempotencyStrategy 

Source
pub enum IdempotencyStrategy<P>
where P: Debug + Clone + Serialize,
{ Provided, Custom(fn(&Event<P>) -> String), Uuid, None, }
Expand description

How an idempotency token is produced when a new event is written.

The variant is evaluated inside OutboxService::add_event before the event is persisted. When an IdempotencyStorageProvider is wired, the produced token is also used to reserve uniqueness up front.

Variants§

§

Provided

Uses the caller-supplied token as-is. Passing None at call site means the event is stored without a token and no reservation is attempted.

§

Custom(fn(&Event<P>) -> String)

Derives the token by applying the given function to the event about to be written. The add_event callback get_event must return Some for this variant — otherwise the service panics.

§

Uuid

Generates a fresh UUID v7 token at write time. Any caller-supplied token is ignored.

§

None

Disables idempotency — no token is produced and no reservation is attempted. This is the default.

Implementations§

Source§

impl<P> IdempotencyStrategy<P>
where P: Debug + Clone + Serialize,

Source

pub fn invoke<F>( &self, provided_token: Option<String>, get_event: F, ) -> Option<String>
where F: FnOnce() -> Option<Event<P>>,

Resolves the strategy into a concrete token for the event about to be written.

Behaviour per variant:

  • Provided — returns provided_token as-is; None propagates through and means the event will be stored without a token.
  • Uuid — generates a fresh UUID v7; provided_token is ignored.
  • Custom — invokes get_event, passes the resulting Event to the user-supplied function, and wraps the returned String in Some.
  • None — returns None; neither provided_token nor get_event is used.

get_event is only evaluated for the Custom branch, so callers can pass || None for every other strategy.

§Panics

Panics if the strategy is set to Custom, but the provided get_event closure returns None. The panic message is "Strategy is Custom, but no Event context provided".

Trait Implementations§

Source§

impl<P> Clone for IdempotencyStrategy<P>
where P: Debug + Clone + Serialize + Clone,

Source§

fn clone(&self) -> IdempotencyStrategy<P>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. 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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

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>,

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