Struct ChatChunk 

pub struct ChatChunk {
    pub content: String,
    pub is_final: bool,
    pub usage_metadata: Option<UsageMetadata>,
    pub finish_reason: Option<String>,
}

A chunk of output from streaming.

This struct carries content deltas during streaming, along with optional metadata that is typically attached to the final chunk.

Fields

content: String

The content delta.

is_final: bool

Whether this is the final chunk.

usage_metadata: Option<UsageMetadata>

Usage metadata (token counts) - typically present on the final chunk.

finish_reason: Option<String>

The reason the model stopped generating (e.g., “stop”, “length”, “tool_calls”). Typically present on the final chunk.

Implementations

impl ChatChunk

pub fn new(content: impl Into<String>) -> Self

Create a new content chunk (non-final).

pub fn final_chunk( usage_metadata: Option<UsageMetadata>, finish_reason: Option<String>, ) -> Self

Create a final chunk with optional metadata.

pub fn with_usage_metadata(self, usage: UsageMetadata) -> Self

Set usage metadata on this chunk.

pub fn with_finish_reason(self, reason: impl Into<String>) -> Self

Set finish reason on this chunk.

Trait Implementations

impl Clone for ChatChunk

fn clone(&self) -> ChatChunk

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatChunk

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatChunk

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatChunk

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

where __S: Serializer,

Serialize this value into the given Serde serializer.