Struct WorkflowEvent 

pub struct WorkflowEvent {
    pub event_type: WorkflowEventType,
    pub elapsed_nanos: Option<u64>,
    pub metadata: Option<WorkflowEventMetadata>,
    pub data: Value,
}

One smol-workflows event stream envelope.

Serialized events are intended to be written as JSON Lines: one complete WorkflowEvent per line. The JSON field name for event_type is type.

Fields

event_type: WorkflowEventType

Event type discriminator, serialized as the top-level type field.

elapsed_nanos: Option<u64>

Nanoseconds since the root workflow stream start.

The root workflow.started event may omit this. All later events, including child workflow.started events, should include it.

metadata: Option<WorkflowEventMetadata>

Optional correlation metadata.

data: Value

Event payload.

The payload shape is defined by the event type. For workflow.agent_event, this is raw provider-owned data.

Implementations

impl WorkflowEvent

pub fn started(start_time: String) -> Self

Construct a workflow.started event.

pub fn log(message: String) -> Self

Construct a workflow.log event.

pub fn phase(name: String, options: Option<Value>) -> Self

Construct a workflow.phase event.

pub fn result( input_tokens: u64, output_tokens: u64, total_tokens: u64, results: Value, ) -> Self

Construct a workflow.result event.

pub fn error(message: String, details: Option<String>) -> Self

Construct a workflow.error event.

pub fn agent_started(data: Value, metadata: WorkflowEventMetadata) -> Self

Construct a workflow.agent_started event.

pub fn agent_event(data: Value, metadata: WorkflowEventMetadata) -> Self

Construct a workflow.agent_event event from raw provider data.

pub fn agent_completed(data: Value, metadata: WorkflowEventMetadata) -> Self

Construct a workflow.agent_completed event.

pub fn agent_failed(data: Value, metadata: WorkflowEventMetadata) -> Self

Construct a workflow.agent_failed event.

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WorkflowEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WorkflowEvent

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 WorkflowEvent