Struct StreamChunk 

#[non_exhaustive]
pub struct StreamChunk {
    pub text: String,
    pub prompt_tokens: Option<u64>,
    pub completion_tokens: Option<u64>,
    pub cached_input_tokens: Option<u64>,
}

A single chunk emitted during streaming inference.

The final chunk in a stream includes token usage counts. Marked #[non_exhaustive] because new fields may be added in future minor releases.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

text: String

The text fragment for this chunk.

prompt_tokens: Option<u64>

Number of prompt tokens (only set on the final chunk).

completion_tokens: Option<u64>

Number of completion tokens (only set on the final chunk).

cached_input_tokens: Option<u64>

Number of prompt tokens that were served from the persistent KV-cache prefix (only set on the final chunk).

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 GetTokenUsage for StreamChunk

fn token_usage(&self) -> Usage

Returns token usage for this response. Zero-valued usage is Usage’s documented sentinel for missing provider usage metrics; response types that carry no usage return Usage::new.

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.