Enum ModelStreamEvent 

#[non_exhaustive]
pub enum ModelStreamEvent {
    ResponseStarted {
        id: Option<String>,
        model: ModelRef,
    },
    ContentBlockStarted {
        index: u32,
        kind: ContentBlockKind,
    },
    TextDelta {
        index: u32,
        text: String,
    },
    ReasoningDelta {
        index: u32,
        text: String,
    },
    ReasoningSignatureDelta {
        index: u32,
        signature: String,
    },
    ToolArgumentsDelta {
        index: u32,
        json: String,
    },
    RefusalDelta {
        index: u32,
        text: String,
    },
    BinaryDelta {
        index: u32,
        data: String,
    },
    ContentBlockCompleted {
        index: u32,
    },
    ContentPartCompleted {
        index: u32,
        part: ContentPart,
    },
    UsageUpdated {
        usage: ModelUsage,
    },
    Warning {
        warning: ModelWarning,
    },
    Heartbeat,
    Provider {
        event: ProviderEvent,
    },
    ResponseCompleted {
        finish_reason: FinishReason,
        provider_metadata: BTreeMap<String, Value>,
    },
    ToolArgumentsCompleted {
        index: u32,
        json: String,
    },
    ContentBlockMetadata {
        index: u32,
        metadata: BTreeMap<String, Value>,
    },
}

Canonical events emitted by a streaming model call.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ResponseStarted

The provider accepted the request and started a response.

Fields

id: Option<String>

Provider response identity.

model: ModelRef

Actual model serving the request.

ContentBlockStarted

A delta-capable content block started.

Fields

index: u32

Stable output ordering index.

kind: ContentBlockKind

Block type and initial metadata.

TextDelta

A text delta.

Fields

index: u32

Target block index.

text: String

Appended text.

ReasoningDelta

A reasoning-text delta.

Fields

index: u32

Target block index.

text: String

Appended reasoning text.

ReasoningSignatureDelta

A reasoning-signature delta.

Fields

index: u32

Target block index.

signature: String

Appended signature data.

ToolArgumentsDelta

A raw JSON fragment for tool arguments.

Fields

index: u32

Target block index.

json: String

Appended raw JSON text.

RefusalDelta

A refusal-text delta.

Fields

index: u32

Target block index.

text: String

Appended refusal text.

BinaryDelta

One independently base64-encoded binary media chunk.

Fields

index: u32

Target image, audio, or document block index.

data: String

Base64-encoded chunk bytes.

ContentBlockCompleted

A delta-capable block completed.

Fields

index: u32

Completed block index.

ContentPartCompleted

A complete non-delta content part arrived.

Fields

index: u32

Stable output ordering index.

part: ContentPart

Completed content.

UsageUpdated

A cumulative usage snapshot.

Fields

usage: ModelUsage

Latest cumulative model usage.

Warning

A translation or feature-degradation warning.

Fields

warning: ModelWarning

Visible warning.

Heartbeat

A provider heartbeat without model content.

Provider

An unknown or provider-specific event.

Fields

event: ProviderEvent

Retained provider event.

ResponseCompleted

The response completed.

Fields

finish_reason: FinishReason

Normalized terminal reason.

provider_metadata: BTreeMap<String, Value>

Namespaced terminal provider metadata.

ToolArgumentsCompleted

The provider’s authoritative complete JSON argument text.

Fields

index: u32

Target tool-call block index.

json: String

Complete raw JSON text, replacing any accumulated deltas.

ContentBlockMetadata

Namespaced metadata for an open or completed content block.

Providers may learn final item metadata only after the delta-capable block itself has completed. Accumulators therefore apply these updates to either state without reopening the block.

Fields

index: u32

Target block index.

metadata: BTreeMap<String, Value>

Namespaced metadata to merge into the canonical content part.

Trait Implementations

impl Clone for ModelStreamEvent

fn clone(&self) -> ModelStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ModelStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ModelStreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelStreamEvent