Enum StreamEvent 

pub enum StreamEvent {
    Start,
    TextDelta {
        content_index: usize,
        delta: String,
    },
    ThinkingDelta {
        content_index: usize,
        delta: String,
    },
    ToolCallStart {
        content_index: usize,
        id: String,
        name: String,
    },
    ToolCallDelta {
        content_index: usize,
        delta: String,
    },
    ToolCallEnd {
        content_index: usize,
    },
    Done {
        message: Message,
    },
    Error {
        message: Message,
    },
}

Events emitted during LLM streaming.

Variants

Start

Stream started — the LLM has begun generating. Consumers should create a placeholder.

TextDelta

A text token from the response text.

Fields

content_index: usize

delta: String

ThinkingDelta

A chunk from the model’s chain-of-thought (extended thinking mode only).

Fields

content_index: usize

delta: String

ToolCallStart

The LLM began a tool call — id and name are now known.

Fields

content_index: usize

id: String

name: String

ToolCallDelta

A JSON fragment for a tool call’s arguments (accumulate until ToolCallEnd).

Fields

content_index: usize

delta: String

ToolCallEnd

The tool call’s argument JSON is complete.

Fields

content_index: usize

Done

Stream completed successfully. message is the final complete Message.

Fields

message: Message

Error

Stream failed. message is a synthetic error Message with stop_reason=Error.

Fields

message: Message

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.