Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    TextDelta(String),
    ReasoningDelta(String),
    ToolCallStart {
        index: u32,
        id: String,
        name: String,
    },
    ToolCallDelta {
        index: u32,
        json_chunk: String,
    },
    ToolCallComplete {
        index: u32,
        call: ToolCall,
    },
    Usage(Usage),
    Done {
        stop_reason: StopReason,
    },
}

An incremental event emitted during a streaming response.

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.

TextDelta(String)

A fragment of the model’s text output.

ReasoningDelta(String)

A fragment of the model’s reasoning (chain-of-thought) output.

ToolCallStart

Announces that a new tool call has started.

Fields

index: u32

Zero-based index identifying this call when multiple tools are invoked in parallel.

id: String

Provider-assigned identifier linking start → deltas → complete.

name: String

The name of the tool being called.

ToolCallDelta

A JSON fragment of the tool call’s arguments.

Fields

index: u32

The tool-call index this delta belongs to.

json_chunk: String

A chunk of the JSON arguments string.

ToolCallComplete

The fully assembled tool call, ready to execute.

Fields

index: u32

The tool-call index this completion corresponds to.

call: ToolCall

The complete, parsed tool call.

Usage(Usage)

Token usage information for the request so far.

Done

The stream has ended.

Fields

stop_reason: StopReason

Why the model stopped generating.

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.

impl<'de> Deserialize<'de> for StreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StreamEvent

fn eq(&self, other: &StreamEvent) -> 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 StreamEvent

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 StreamEvent