Enum RuntimeCommand 

#[non_exhaustive]
pub enum RuntimeCommand {
    Complete {
        output: JsonValue,
    },
    Fail {
        error: String,
    },
    Cancel,
    Timeout {
        deadline: DateTime<Utc>,
        reason: Option<String>,
    },
    ContinueAsNew {
        input: JsonValue,
    },
    RecordProgress {
        progress: WorkflowProgress,
    },
    LinkChildOperation {
        child: ChildOperationReference,
    },
    StartChildWorkflow {
        child_id: String,
        spec: WorkflowSpec,
        input: JsonValue,
        cancellation_policy: ChildWorkflowCancellationPolicy,
    },
    ScheduleStep {
        step_id: String,
        step_name: String,
        input: JsonValue,
        retry: RetryPolicy,
    },
    ScheduleSteps {
        steps: Vec<StepCommand>,
    },
    WaitUntil {
        wait_id: String,
        resume_at: DateTime<Utc>,
    },
    CreateHook {
        hook_id: String,
        token: String,
        metadata: JsonValue,
    },
    WaitForSignal {
        wait_id: String,
        signal_name: String,
    },
    StartChildWorkflows {
        children: Vec<ChildWorkflowCommand>,
    },
}

Command emitted by the workflow runtime after replay.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Complete

Completes the workflow run successfully.

Fields

output: JsonValue

Final JSON value returned by the workflow.

Fail

Fails the workflow run with an application error.

Fields

error: String

Human-readable failure description.

Cancel

Finish a previously requested cleanup-aware cancellation.

Timeout

Finish a run with a typed timeout outcome.

Fields

deadline: DateTime<Utc>

UTC deadline that caused the timeout.

reason: Option<String>

Optional context for the timeout decision.

ContinueAsNew

Close this history segment and start a successor with the same spec.

Fields

input: JsonValue

Initial JSON input for the successor run.

RecordProgress

Persist progress before replaying the workflow.

Fields

progress: WorkflowProgress

Progress value exposed through inspection and observation APIs.

LinkChildOperation

Persist a parent-to-child operation reference before replaying.

Fields

child: ChildOperationReference

Stable reference to the externally managed child operation.

StartChildWorkflow

Start or await a first-class child workflow with a stable parent-local id.

Fields

child_id: String

Replay-stable parent-local child identifier.

spec: WorkflowSpec

Workflow definition used to create the child.

input: JsonValue

Initial JSON input supplied to the child.

cancellation_policy: ChildWorkflowCancellationPolicy

Policy applied when the parent is cancelled or terminated.

ScheduleStep

Schedules one durable step or awaits its recorded outcome.

Fields

step_id: String

Replay-stable identity of the step.

step_name: String

Registered step implementation name.

input: JsonValue

JSON input supplied to the step.

retry: RetryPolicy

Retry behavior pinned when the step is created.

ScheduleSteps

Atomically schedules a batch of durable steps.

Fields

steps: Vec<StepCommand>

Step definitions in deterministic scheduling order.

WaitUntil

Suspends replay until a UTC deadline becomes ready.

Fields

wait_id: String

Replay-stable identity of the timer wait.

resume_at: DateTime<Utc>

UTC time at which the wait becomes ready.

CreateHook

Creates an externally completable hook.

Fields

hook_id: String

Replay-stable identity of the hook.

token: String

Secret bearer token required to deliver the hook.

metadata: JsonValue

Application metadata persisted with the hook.

WaitForSignal

Suspend until the next unconsumed signal with signal_name is paired with this stable wait identity.

Fields

wait_id: String

Replay-stable identity of the signal wait.

signal_name: String

Declared signal contract accepted by the wait.

StartChildWorkflows

Request a bounded batch before any first-class child starts.

Fields

children: Vec<ChildWorkflowCommand>

Child definitions in deterministic request order.

Implementations

impl RuntimeCommand

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

Creates a single-step schedule command with the default retry policy.

pub fn schedule_steps(steps: Vec<StepCommand>) -> Self

Creates an atomic batch scheduling command.

pub fn start_child_workflows(children: Vec<ChildWorkflowCommand>) -> Self

Create a bounded batch child-workflow command.

Trait Implementations

impl Clone for RuntimeCommand

fn clone(&self) -> RuntimeCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuntimeCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RuntimeCommand

fn eq(&self, other: &RuntimeCommand) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for RuntimeCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RuntimeCommand