Enum StreamChunk 

pub enum StreamChunk {
    Text(String),
    ToolUseStart {
        index: usize,
        id: String,
        name: String,
    },
    ToolUseInputDelta {
        index: usize,
        partial_json: String,
    },
    ToolUseComplete {
        index: usize,
        tool_call: ToolCall,
    },
    Done {
        stop_reason: String,
    },
    Usage(Usage),
}

A streaming chunk that can be either text or a tool call event.

This enum provides a unified representation of streaming events when using chat_stream_with_tools. It allows callers to receive text deltas as they arrive while also handling tool use blocks.

Variants

Text(String)

Text content delta

ToolUseStart

Tool use block started (contains tool id and name)

Fields

index: usize

The index of this content block in the response

id: String

The unique ID for this tool use

name: String

The name of the tool being called

ToolUseInputDelta

Tool use input JSON delta (partial JSON string)

Fields

index: usize

The index of this content block

partial_json: String

Partial JSON string for the tool input

ToolUseComplete

Tool use block complete with assembled ToolCall

Fields

index: usize

The index of this content block

tool_call: ToolCall

The complete tool call with id, name, and parsed arguments

Done

Stream ended with stop reason

Fields

stop_reason: String

The reason the stream stopped (e.g., “end_turn”, “tool_use”)

Usage(Usage)

Trait Implementations

impl Clone for StreamChunk

fn clone(&self) -> StreamChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamChunk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.