Struct WorkflowCtx

pub struct WorkflowCtx<S: Context> {
    pub store: S,
    /* private fields */
}

The context for a workflow execution.

The context contains the store, cancellation token, and optional timeout.

Fields

store: S

The store for the workflow.

Implementations

impl<S: Context> WorkflowCtx<S>

pub fn new(store: S) -> Self

Creates a new workflow context with the given store.

pub fn with_store<F, R>(&self, f: F) -> R

where F: FnOnce(&S) -> R,

Runs the provided function with a reference to the store.

pub fn cancel_token(&self) -> &CancellationToken

Returns a reference to the cancellation token.

pub fn set_timeout(&mut self, d: Duration)

Sets a timeout for the workflow.

pub fn cancel(&self)

Cancel the workflow execution.

pub fn is_cancelled(&self) -> bool

Returns true if the workflow has been cancelled.

pub async fn cancelled(&self)

Asynchronously wait until the workflow is cancelled.

pub async fn run_future<R, F>(&self, fut: F) -> Result<R, FloxideError>

where F: Future<Output = Result<R, FloxideError>>,

Runs the provided future, respecting cancellation and optional timeout.

Trait Implementations

impl<S: Clone + Context> Clone for WorkflowCtx<S>

fn clone(&self) -> WorkflowCtx<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S: Debug + Context> Debug for WorkflowCtx<S>

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

Formats the value using the given formatter.

impl<S: Context> RetryDelay for WorkflowCtx<S>

fn wait<'life0, 'async_trait>( &'life0 self, dur: Duration, ) -> Pin<Box<dyn Future<Output = Result<(), FloxideError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Wait the given duration, returning an error if cancelled or timed out.