Enum StreamEvent 

pub enum StreamEvent {
    Text(String),
    Reasoning(ReasoningChunk),
    ToolCall(ToolCall),
    Status(String),
    Done {
        tokens: usize,
    },
}

A single event emitted during a streaming model call.

Adapters MUST emit Done exactly once at the end of a successful stream. Text and Reasoning may interleave in any order. ToolCall events typically arrive at the end of generation but the contract is “before Done”.

Variants

Text(String)

Plain assistant content. Append to the response buffer.

Reasoning(ReasoningChunk)

Reasoning / thinking content. Render separately from regular text; renderer decides whether to display or hide based on user prefs.

ToolCall(ToolCall)

A tool/function call extracted from the model response.

Status(String)

Out-of-band, user-visible plumbing notice (e.g. “Starting the local Ollama server…”). NOT response content: surfaces as a transient / system line, never appended to the assistant message. May arrive before any Text.

Done

Stream complete. Carries the total token usage if reported by the provider; 0 if unavailable (still meaningful — the caller knows generation finished).

Fields

tokens: usize

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.