Enum WorkflowEvent 

pub enum WorkflowEvent {
    Started,
    Status(WorkflowRunState),
    SuperStepStarted(usize),
    SuperStepCompleted(usize),
    ExecutorInvoked {
        executor_id: String,
    },
    ExecutorCompleted {
        executor_id: String,
    },
    ExecutorFailed {
        executor_id: String,
        error: String,
    },
    AgentRunUpdate {
        executor_id: String,
        update: Value,
    },
    AgentRun {
        executor_id: String,
        response: Value,
    },
    Output {
        data: Value,
        source_executor_id: String,
    },
    Intermediate {
        data: Value,
        source_executor_id: String,
    },
    Custom(Value),
    RequestInfo {
        request_id: String,
        source_executor_id: String,
        request_data: Value,
    },
    Failed {
        error: String,
    },
}

An event observed while a workflow runs.

Corresponds to the WorkflowEvent hierarchy in the Python engine. Only workflow-level events are observable; inter-executor messages are internal. Variant names map onto Python types as noted (e.g. WorkflowEvent::Started is WorkflowStartedEvent, WorkflowEvent::Output is WorkflowOutputEvent).

Variants

Started

The run has begun (WorkflowStartedEvent).

Status(WorkflowRunState)

A run-state transition (WorkflowStatusEvent).

SuperStepStarted(usize)

A superstep has started, with its 1-based iteration index.

SuperStepCompleted(usize)

A superstep has completed, with its 1-based iteration index.

ExecutorInvoked

An executor began processing a message (ExecutorInvokedEvent).

Fields

executor_id: String

ExecutorCompleted

An executor finished processing (ExecutorCompletedEvent).

Fields

executor_id: String

ExecutorFailed

An executor failed (ExecutorFailedEvent).

Fields

executor_id: String

error: String

AgentRunUpdate

An agent produced an incremental streaming update (AgentRunUpdateEvent).

Fields

executor_id: String

update: Value

AgentRun

An agent completed a run (AgentRunEvent).

Fields

executor_id: String

response: Value

Output

A workflow-level output was yielded (WorkflowOutputEvent).

Terminal: recorded as (part of) the run’s final output. Emitted for yields from an executor named by WorkflowBuilder::output_from, or from any executor when no output designation is configured at all (see WorkflowEvent::Intermediate for the non-terminal counterpart).

Fields

data: Value

source_executor_id: String

Intermediate

A non-terminal, workflow-level progress signal.

Mirrors upstream’s intermediate yield classification: emitted for yields from an executor named by WorkflowBuilder::intermediate_output_from, and (when an output_from allowlist is configured) for yields from any executor not on that allowlist, as a safe non-terminal fallback. Never recorded as the run’s final output (WorkflowRun::last_output ignores it).

Fields

data: Value

source_executor_id: String

Custom(Value)

A custom event added by an executor.

RequestInfo

A request for external input, human-in-the-loop (RequestInfoEvent).

Fields

request_id: String

source_executor_id: String

The executor that surfaced the request (the emitter).

request_data: Value

Failed

The run failed terminally (WorkflowFailedEvent).

Fields

error: String

Implementations

impl WorkflowEvent

pub fn as_output(&self) -> Option<&Value>

If this is an WorkflowEvent::Output, return the data.

pub fn as_intermediate(&self) -> Option<&Value>

If this is a WorkflowEvent::Intermediate, return the data.

pub fn as_request_info(&self) -> Option<(&str, &Value)>

If this is a WorkflowEvent::RequestInfo, return (request_id, data).

pub fn as_status(&self) -> Option<WorkflowRunState>

If this is a WorkflowEvent::Status, return the state.

Trait Implementations

impl Clone for WorkflowEvent

fn clone(&self) -> WorkflowEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorkflowEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<WorkflowEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorkflowEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.