Enum ChatStreamEvent 

pub enum ChatStreamEvent {
    ContentDelta {
        delta: String,
        index: Option<usize>,
    },
    ToolCallDelta {
        id: String,
        function_name: Option<String>,
        arguments_delta: Option<String>,
        index: Option<usize>,
    },
    ThinkingDelta {
        delta: String,
    },
    UsageUpdate {
        usage: Usage,
    },
    StreamStart {
        metadata: ResponseMetadata,
    },
    StreamEnd {
        response: ChatResponse,
    },
    Error {
        error: String,
    },
}

Chat streaming event

Variants

ContentDelta

Content delta (incremental text)

Fields

delta: String

The incremental text content

index: Option<usize>

Index of the choice (for multiple responses)

ToolCallDelta

Tool call delta

Fields

id: String

Tool call ID

function_name: Option<String>

Function name (if this is the start of a tool call)

arguments_delta: Option<String>

Incremental arguments

index: Option<usize>

Index of the choice

ThinkingDelta

Thinking/reasoning content delta (for models that support internal reasoning) This includes content from <think> tags, reasoning fields, and thinking modes

Fields

delta: String

The incremental thinking/reasoning content

UsageUpdate

Usage statistics update

Fields

usage: Usage

Token usage information

StreamStart

Stream start event with metadata

Fields

metadata: ResponseMetadata

Response metadata

StreamEnd

Stream end event with final response

Fields

response: ChatResponse

Final response

Error

Error occurred during streaming

Fields

error: String

Error message

Trait Implementations

impl Clone for ChatStreamEvent

fn clone(&self) -> ChatStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatStreamEvent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.