Skip to main content

CompensationBuilder

Struct CompensationBuilder 

Source
pub struct CompensationBuilder<'a, S> { /* private fields */ }
Expand description

Undoes a closure effect. Created by Runtime::compensation.

Implementations§

Source§

impl<'a, S: EffectStore> CompensationBuilder<'a, S>

Source

pub fn reason(self, reason: impl Into<String>) -> Self

Why the effect is being undone; recorded in the audit trail.

Source

pub fn actor(self, actor: impl Into<String>) -> Self

Who is undoing it, e.g. agent:support-bot.

Source

pub fn retry(self, policy: RetryPolicy) -> Self

The retry policy for compensation attempts; defaults to the runtime’s. Its max_attempts bounds attempts over the compensation’s life.

Source

pub fn attempt_timeout(self, timeout: Duration) -> Self

Gives up waiting for one attempt after timeout, and retries.

Source

pub async fn run<T, F, Fut>( self, compensate: F, ) -> Result<CompensationOutcome, RuntimeError>
where T: DeserializeOwned + Send + 'static, F: Fn(CompensationContext, Option<T>) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), EffectFailure>> + Send + 'static,

Undoes the effect with compensate, which receives the effect’s stored output (None if it had none). Calling again after it is undone returns CompensationOutcome::Compensated without running anything.

§Errors

Infrastructure failures, an invalid name or key, or no such effect.

Auto Trait Implementations§

§

impl<'a, S> !RefUnwindSafe for CompensationBuilder<'a, S>

§

impl<'a, S> !UnwindSafe for CompensationBuilder<'a, S>

§

impl<'a, S> Freeze for CompensationBuilder<'a, S>
where &'a Runtime<S>: Freeze,

§

impl<'a, S> Send for CompensationBuilder<'a, S>
where &'a Runtime<S>: Send,

§

impl<'a, S> Sync for CompensationBuilder<'a, S>
where &'a Runtime<S>: Sync,

§

impl<'a, S> Unpin for CompensationBuilder<'a, S>
where &'a Runtime<S>: Unpin,

§

impl<'a, S> UnsafeUnpin for CompensationBuilder<'a, S>
where &'a Runtime<S>: UnsafeUnpin,

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