Enum AgentStreamEvent 

pub enum AgentStreamEvent<Output = Value> {
    RunStart {
        run_id: String,
        step: u32,
    },
    RequestStart {
        step: u32,
    },
    TextDelta {
        content: String,
        part_index: usize,
    },
    ToolCallStart {
        name: String,
        tool_call_id: Option<String>,
        index: usize,
    },
    ToolCallDelta {
        args_delta: String,
        index: usize,
    },
    ToolCallComplete {
        name: String,
        args: Value,
        index: usize,
    },
    ToolResult {
        name: String,
        result: Value,
        success: bool,
        index: usize,
    },
    ThinkingDelta {
        content: String,
        index: usize,
    },
    PartialOutput {
        output: Output,
    },
    ResponseComplete {
        response: ModelResponse,
    },
    UsageUpdate {
        usage: RequestUsage,
    },
    FinalOutput {
        output: Output,
    },
    RunComplete {
        run_id: String,
        total_steps: u32,
    },
    Error {
        message: String,
        recoverable: bool,
    },
}

Events emitted during streaming.

Variants

RunStart

Run started.

Fields

run_id: String

The run ID.

step: u32

Step number (0 for start).

RequestStart

Model request started.

Fields

step: u32

Current step number.

TextDelta

Text delta received.

Fields

content: String

The text content.

part_index: usize

Index of the part this delta belongs to.

ToolCallStart

Tool call started.

Fields

name: String

Tool name.

tool_call_id: Option<String>

Tool call ID (if available).

index: usize

Index of this tool call.

ToolCallDelta

Tool call arguments delta.

Fields

args_delta: String

Arguments delta (JSON string).

index: usize

Index of this tool call.

ToolCallComplete

Tool call completed.

Fields

name: String

Tool name.

args: Value

Complete arguments.

index: usize

Index of this tool call.

ToolResult

Tool result received.

Fields

name: String

Tool name.

result: Value

Result content.

success: bool

Whether the tool succeeded.

index: usize

Index of this tool call.

ThinkingDelta

Thinking delta (for Claude extended thinking).

Fields

content: String

The thinking content.

index: usize

Index of this thinking part.

PartialOutput

Partial output available (validated incrementally).

Fields

output: Output

The partial output.

ResponseComplete

Model response complete.

Fields

response: ModelResponse

The complete response.

UsageUpdate

Usage update.

Fields

usage: RequestUsage

Current usage.

FinalOutput

Final output ready.

Fields

output: Output

The final output.

RunComplete

Run complete.

Fields

run_id: String

The run ID.

total_steps: u32

Total steps.

Error

Error occurred.

Fields

message: String

Error message.

recoverable: bool

Whether the error is recoverable.

Implementations

impl<Output> AgentStreamEvent<Output>

pub fn run_start(run_id: impl Into<String>, step: u32) -> Self

Create a run start event.

pub fn text_delta(content: impl Into<String>, part_index: usize) -> Self

Create a text delta event.

pub fn error(message: impl Into<String>, recoverable: bool) -> Self

Create an error event.

pub fn is_terminal(&self) -> bool

Check if this is the final event.

pub fn is_error(&self) -> bool

Check if this is an error event.

pub fn as_text(&self) -> Option<&str>

Get the text content if this is a text delta.

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

Get the output if this is a final output event.

pub fn map_output<U, F>(self, f: F) -> AgentStreamEvent<U>

where F: FnOnce(Output) -> U,

Map the output type.

Trait Implementations

impl<Output: Clone> Clone for AgentStreamEvent<Output>

fn clone(&self) -> AgentStreamEvent<Output>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Output: Debug> Debug for AgentStreamEvent<Output>

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

Formats the value using the given formatter.

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

where Output: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Output: Display> Display for AgentStreamEvent<Output>

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

Formats the value using the given formatter.

impl<Output> Serialize for AgentStreamEvent<Output>

where Output: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.