Enum AgentStreamEvent 

#[non_exhaustive]
pub enum AgentStreamEvent {
    Started {
        agent: String,
    },
    TurnStarted {
        turn: u32,
    },
    Model {
        turn: u32,
        event: ModelStreamEvent,
    },
    ContextRetrieved {
        source: String,
        documents: usize,
    },
    CallableStarted {
        turn: u32,
        kind: CallableKind,
        call: ToolCall,
    },
    CallableCompleted {
        turn: u32,
        kind: CallableKind,
        call_id: String,
        name: String,
        success: bool,
    },
    UsageUpdated {
        usage: Usage,
    },
    Completed {
        outcome: AgentOutcome,
    },
}

One real-time event from the canonical Agent execution loop.

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.

Started

The Agent execution started.

Fields

agent: String

Stable local Agent name.

TurnStarted

A model turn started.

Fields

turn: u32

One-based turn number.

Model

One provider-neutral model streaming event.

Fields

turn: u32

One-based owning turn.

event: ModelStreamEvent

Canonical event accepted by the model stream accumulator.

ContextRetrieved

One dynamic context source completed retrieval.

Fields

source: String

Operator-visible source name.

documents: usize

Number of documents injected into the transcript.

CallableStarted

A Tool or child Agent call started.

Fields

turn: u32

One-based owning turn.

kind: CallableKind

Callable boundary.

call: ToolCall

Canonical model-emitted call.

CallableCompleted

A Tool or child Agent call reached a recoverable terminal result.

Fields

turn: u32

One-based owning turn.

kind: CallableKind

Callable boundary.

call_id: String

Model-emitted call identity.

name: String

Model-facing callable name.

success: bool

Whether execution produced a successful output.

UsageUpdated

Shared run-tree resource usage changed.

Fields

usage: Usage

Latest cumulative usage snapshot.

Completed

The Agent reached a terminal model response.

Fields

outcome: AgentOutcome

Complete canonical outcome.

Trait Implementations

impl Clone for AgentStreamEvent

fn clone(&self) -> AgentStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AgentStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AgentStreamEvent

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 AgentStreamEvent