Struct WorkflowContext 

pub struct WorkflowContext<'a> { /* private fields */ }

Replay helper for Rust workflow runtimes.

WorkflowContext is a read-only view over a workflow invocation. It provides deterministic helpers for inspecting persisted history and returning the next command to the engine.

Implementations

impl<'a> WorkflowContext<'a>

pub fn new(invocation: &'a WorkflowInvocation) -> Self

Creates a replay context over one immutable runtime invocation.

pub fn run_id(&self) -> &str

Returns the stable run identifier.

pub fn input(&self) -> &JsonValue

Returns the workflow’s initial JSON input.

pub fn spec(&self) -> &WorkflowSpec

Return the immutable workflow definition pinned by run_created.

pub fn has_patch_marker(&self, patch_id: &str) -> bool

Return whether this run was created with a replay-safe patch marker.

Marker presence never changes for an existing run. A compatible runtime can therefore keep both code paths and deterministically replay old unmarked histories alongside new marked histories.

pub fn input_as<T>(&self) -> Result<T>

where T: DeserializeOwned,

Decode the workflow input into a host-defined serde type.

pub fn history(&self) -> &[FlowEventEnvelope]

Returns committed history in ascending event-sequence order.

pub fn cancellation_request(&self) -> Option<&CancellationRequest>

Return the durable cleanup-aware cancellation request, when present.

pub fn progress(&self, progress_id: &str) -> Option<&WorkflowProgress>

Return a durable progress update by its idempotency identity.

pub fn child_operation( &self, reference_id: &str, ) -> Option<&ChildOperationReference>

Return a durable child-operation reference by its parent-local id.

pub fn child_workflow_run_id(&self, child_id: &str) -> Option<&str>

Return the engine-generated root run ID for a durable child request.

pub fn child_workflow_outcome( &self, child_id: &str, ) -> Option<&WorkflowTerminalOutcome>

Return the terminal outcome durably observed for a child workflow.

pub fn signal(&self, signal_id: &str) -> Option<&WorkflowSignal>

Return a received signal by its caller-owned delivery identity.

pub fn signal_payload(&self, wait_id: &str) -> Option<&JsonValue>

Return the payload paired with a completed deterministic signal wait.

pub fn signal_payload_as<T>(&self, wait_id: &str) -> Result<Option<T>>

where T: DeserializeOwned,

Decode the payload paired with a completed deterministic signal wait.

pub fn step_output(&self, step_id: &str) -> Option<&JsonValue>

Returns the durable JSON output of a completed step.

pub fn step_output_as<T>(&self, step_id: &str) -> Result<Option<T>>

where T: DeserializeOwned,

Decodes a completed step output into a host-defined serde type.

pub fn step_completed(&self, step_id: &str) -> bool

Returns whether the step has a durable successful output.

pub fn step_failed(&self, step_id: &str) -> Option<&str>

Returns the terminal error of a step that exhausted its retries.

pub fn wait_completed(&self, wait_id: &str) -> bool

Returns whether a durable timer wait has completed.

pub fn hook_payload(&self, hook_id: &str) -> Option<&JsonValue>

Returns the durable JSON payload received by a hook.

pub fn hook_payload_as<T>(&self, hook_id: &str) -> Result<Option<T>>

where T: DeserializeOwned,

Decodes a received hook payload into a host-defined serde type.

pub fn hook_disposed(&self, hook_id: &str) -> bool

Returns whether a hook was explicitly closed without a payload.

pub fn complete(&self, output: JsonValue) -> RuntimeCommand

Returns a command that completes the workflow successfully.

pub fn fail(&self, error: impl Into<String>) -> RuntimeCommand

Returns a command that fails the workflow.

pub fn cancel(&self) -> RuntimeCommand

Finish a previously requested cancellation after cleanup is durable.

pub fn timeout( &self, deadline: DateTime<Utc>, reason: Option<String>, ) -> RuntimeCommand

Finish a run with a typed timeout outcome.

pub fn continue_as_new(&self, input: JsonValue) -> RuntimeCommand

Close this history segment and continue with fresh history and input.

The engine persists the successor identity before creating it and carries the exact current WorkflowSpec into the new run.

pub fn record_progress(&self, progress: WorkflowProgress) -> RuntimeCommand

Persist an idempotently identified progress update and replay.

pub fn link_child_operation( &self, child: ChildOperationReference, ) -> RuntimeCommand

Persist a child-operation reference and replay.

pub fn start_child_workflow( &self, child_id: impl Into<String>, spec: WorkflowSpec, input: JsonValue, ) -> RuntimeCommand

Start or await a first-class child workflow.

The child ID is stable within this parent history. By default, a parent cancellation request is propagated to an open child and the parent waits for the child’s terminal outcome.

pub fn start_child_workflow_with_policy( &self, child_id: impl Into<String>, spec: WorkflowSpec, input: JsonValue, cancellation_policy: ChildWorkflowCancellationPolicy, ) -> RuntimeCommand

Start or await a child with an explicit cancellation policy.

pub fn child_workflow( &self, child_id: impl Into<String>, spec: WorkflowSpec, input: JsonValue, ) -> ChildWorkflowCommand

Create a child definition for a bounded durable batch.

pub fn child_workflow_with_policy( &self, child_id: impl Into<String>, spec: WorkflowSpec, input: JsonValue, cancellation_policy: ChildWorkflowCancellationPolicy, ) -> ChildWorkflowCommand

Create a batch child definition with an explicit cancellation policy.

pub fn start_child_workflows( &self, children: Vec<ChildWorkflowCommand>, ) -> RuntimeCommand

Durably request a deterministic batch before any child starts.

pub fn schedule_step( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, ) -> RuntimeCommand

Schedules one durable step with the default retry policy.

pub fn schedule_step_with_retry( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, retry: RetryPolicy, ) -> RuntimeCommand

Schedules one durable step with an explicit retry policy.

pub fn step( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, ) -> StepCommand

Creates a step definition with the default retry policy.

pub fn step_with_retry( &self, step_id: impl Into<String>, step_name: impl Into<String>, input: JsonValue, retry: RetryPolicy, ) -> StepCommand

Creates a step definition with an explicit retry policy.

pub fn schedule_steps(&self, steps: Vec<StepCommand>) -> RuntimeCommand

Atomically schedules a deterministic batch of durable steps.

pub fn wait_until( &self, wait_id: impl Into<String>, resume_at: DateTime<Utc>, ) -> RuntimeCommand

Suspends replay until the given UTC deadline becomes ready.

pub fn create_hook( &self, hook_id: impl Into<String>, token: impl Into<String>, metadata: JsonValue, ) -> RuntimeCommand

Creates an externally completable hook with JSON metadata.

pub fn create_hook_with_metadata( &self, hook_id: impl Into<String>, token: impl Into<String>, metadata: HookMetadata, ) -> Result<RuntimeCommand>

Creates an externally completable hook with typed metadata.

pub fn wait_for_signal( &self, wait_id: impl Into<String>, signal_name: impl Into<String>, ) -> RuntimeCommand

Suspend until the next queued signal with signal_name is paired with the stable wait_id.