Enum StreamChunk 

pub enum StreamChunk {
    TextDelta {
        delta: String,
    },
    ToolCall {
        name: String,
        arguments: Value,
    },
    Progress {
        message: String,
        fraction: Option<f32>,
    },
    Artifact {
        name: String,
        data: Value,
        mime_type: Option<String>,
    },
    Final {
        output: Value,
    },
    Error {
        message: String,
    },
}

A typed stream chunk for structured streaming across all protocol adapters.

Follows the OTel GenAI structured streaming convention: text_delta → tool_call → progress → artifact → final

Variants

TextDelta

Incremental text delta (LLM streaming tokens).

Fields

delta: String

ToolCall

A tool call invocation during streaming.

Fields

name: String

arguments: Value

Progress

Progress indicator (0.0–1.0).

Fields

message: String

fraction: Option<f32>

Artifact

A completed artifact (file, data, structured output).

Fields

name: String

data: Value

mime_type: Option<String>

Final

Final completed output. Signals end of stream.

Fields

output: Value

Error

Error that terminates the stream.

Fields

message: String

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.