Skip to main content

StepRunner

Struct StepRunner 

Source
pub struct StepRunner<'a, T>
where T: Serialize + DeserializeOwned + Clone + Send + Sync + 'static,
{ /* private fields */ }
Expand description

A fluent builder for executing workflow steps.

Created via WorkflowContext::step().

Implementations§

Source§

impl<'a, T> StepRunner<'a, T>
where T: Serialize + DeserializeOwned + Clone + Send + Sync + 'static,

Source

pub fn compensate<F, Fut>(self, f: F) -> Self
where F: Fn(T) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<()>> + Send + 'static,

Set a compensation function (rollback handler).

If a later step fails, this compensation function will be called with the step’s result to undo its effects (saga pattern).

ctx.step("charge_card", || async { charge(&card).await })
    .compensate(|charge_result| async move {
        refund(&charge_result.charge_id).await
    })
    .run()
    .await?;
Source

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

Set a timeout for this step.

ctx.step("slow_operation", || async { slow_op().await })
    .timeout(Duration::from_secs(30))
    .run()
    .await?;
Source

pub fn optional(self) -> Self

Mark step as optional.

If an optional step fails, the workflow continues without triggering compensation of previous steps.

ctx.step("send_notification", || async { notify_slack().await })
    .optional()
    .run()
    .await?; // Won't fail workflow if notification fails
Source

pub async fn run(self) -> Result<T>

Execute the step.

This runs the step with configured timeout and compensation settings. Returns the step result or an error.

Note: For retry support with the fluent API, consider using a retryable wrapper inside your step function, or use the low-level API with manual retry logic.

Auto Trait Implementations§

§

impl<'a, T> Freeze for StepRunner<'a, T>

§

impl<'a, T> !RefUnwindSafe for StepRunner<'a, T>

§

impl<'a, T> Send for StepRunner<'a, T>

§

impl<'a, T> !Sync for StepRunner<'a, T>

§

impl<'a, T> Unpin for StepRunner<'a, T>

§

impl<'a, T> !UnwindSafe for StepRunner<'a, T>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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 = 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<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