Enum StreamEvent 

pub enum StreamEvent {
    Text(String),
    Reasoning(ReasoningChunk),
    ToolCall(ToolCall),
    ThinkingSignature(String),
    Done {
        usage: Option<TokenUsage>,
        thinking_signature: Option<String>,
        stop_reason: Option<FinishReason>,
    },
}

One event emitted during a streaming model call. Adapters MUST emit exactly one Done at the end of a successful stream. Text and Reasoning may interleave. ToolCall events typically arrive near the end but the contract is “before Done”.

Variants

Text(String)

Reasoning(ReasoningChunk)

ToolCall(ToolCall)

ThinkingSignature(String)

Optional — some providers emit a signature mid-stream (Anthropic). Adapters that only have it at the end can attach it to Done instead.

Done

Stream complete. Carries final token usage (None if unknown), any terminal thinking signature, and why generation stopped (so the reducer can flag truncation / a content block).

Fields

usage: Option<TokenUsage>

thinking_signature: Option<String>

stop_reason: Option<FinishReason>

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.