Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    TextDelta(String),
    ReasoningDelta(String),
    ToolCallStart {
        id: String,
        name: String,
    },
    ToolCallDelta {
        id: String,
        arguments: String,
    },
    Done(ChatResponse),
}

What a stream yields. The last item is always StreamEvent::Done (or an error).

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)

More answer text.

ReasoningDelta(String)

More reasoning text (when the provider shows it).

ToolCallStart

The model started a tool call.

Fields

id: String

name: String

ToolCallDelta

More JSON of a tool call’s arguments.

Fields

id: String

arguments: String

Done(ChatResponse)

The complete response, the same as a non-streaming call would return.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> Self

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 PartialEq for StreamEvent

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StreamEvent