Enum LlmResponseChunk 

pub enum LlmResponseChunk {
    MessageStart {
        id: Option<String>,
        model: Option<String>,
    },
    TextDelta {
        index: usize,
        text: String,
    },
    ReasoningDelta {
        index: usize,
        text: String,
    },
    ReasoningDetailsDelta {
        index: usize,
        details: Vec<Value>,
        text: String,
    },
    ToolCallDelta {
        index: usize,
        id: Option<String>,
        name: Option<String>,
        arguments_delta: Option<String>,
    },
    Usage(Usage),
    MessageStop {
        reason: Option<String>,
    },
    DecodeError {
        message: String,
    },
    StreamError {
        message: String,
    },
}

One provider-neutral streaming response chunk.

Variants

MessageStart

Starts a response message, or fills in identity first supplied by a later frame.

Fields

id: Option<String>

Provider response identifier.

model: Option<String>

Model reported by the provider.

TextDelta

Adds text to one output index.

Fields

index: usize

Provider output index.

text: String

Text fragment.

ReasoningDelta

Adds reasoning text to one output index.

Fields

index: usize

Provider output index.

text: String

Reasoning fragment.

ReasoningDetailsDelta

Adds structured reasoning details to one output index.

Fields

index: usize

Provider output index.

details: Vec<Value>

Reasoning detail objects in provider order.

text: String

Normalized reasoning text represented by or accompanying the details.

ToolCallDelta

Adds or updates a tool call at one index.

Fields

index: usize

Tool-call index within the response.

id: Option<String>

Tool-call identifier, normally supplied by the first delta.

name: Option<String>

Tool name, normally supplied by the first delta.

arguments_delta: Option<String>

Fragment of the serialized tool arguments.

Usage(Usage)

Reports token usage, normally near the end of the stream.

MessageStop

Ends a response message.

Fields

reason: Option<String>

Provider stop-reason string before normalization.

DecodeError

Reports that an inbound stream event could not be decoded.

Fields

message: String

Human-readable decoding failure.

StreamError

Reports an upstream failure delivered inside an otherwise successful stream.

Fields

message: String

Human-readable upstream failure.

Trait Implementations

impl Clone for LlmResponseChunk

fn clone(&self) -> LlmResponseChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LlmResponseChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LlmResponseChunk

fn deserialize<__D>( __deserializer: __D, ) -> Result<LlmResponseChunk, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<LlmResponseChunk> for LlmResponseStreamEvent

fn from(chunk: LlmResponseChunk) -> LlmResponseStreamEvent

Converts to this type from the input type.

impl PartialEq for LlmResponseChunk

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LlmResponseChunk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LlmResponseChunk