Enum ProviderStreamEvent 

pub enum ProviderStreamEvent {
    TextDelta {
        delta: String,
        opaque: Value,
    },
    ToolCallStarted {
        id: String,
        name: String,
        opaque: Value,
    },
    ToolCallArgumentsDelta {
        id: String,
        delta: String,
        opaque: Value,
    },
    ToolCallCompleted {
        call: ToolCall,
        opaque: Value,
    },
    Usage {
        usage: TokenUsage,
        opaque: Value,
    },
    Completed {
        turn: ProviderTurn,
    },
    Opaque {
        event_type: String,
        payload: Value,
    },
}

Provider-neutral events emitted while one model turn is in progress.

Every incrementally normalized event retains the complete provider frame in opaque. Consumers must treat that value as versioned provider data rather than infer portable semantics from it.

Variants

TextDelta

Public assistant text that can be rendered immediately.

Fields

delta: String

Newly received text; it is not the accumulated response.

opaque: Value

Complete provider frame that produced the delta.

ToolCallStarted

A client-executed tool call whose stable identity and name are known.

Fields

id: String

Provider call identifier used for later deltas and results.

name: String

Registered tool name.

opaque: Value

Complete provider frame that announced the call.

ToolCallArgumentsDelta

A partial JSON string for one tool call’s arguments.

The delta is deliberately not parsed until the provider marks the call complete. Partial JSON is not safe to execute.

Fields

id: String

Provider call identifier.

delta: String

Newly received JSON fragment.

opaque: Value

Complete provider frame that produced the fragment.

ToolCallCompleted

A fully normalized tool call whose arguments are valid JSON.

Fields

call: ToolCall

Structured call ready for runtime validation and policy checks.

opaque: Value

Complete provider frame that finalized the call.

Usage

Provider-reported cumulative token accounting.

Fields

usage: TokenUsage

Latest normalized usage counters.

opaque: Value

Complete provider frame containing the counters.

Completed

Canonical terminal result for the provider turn.

Fields

turn: ProviderTurn

Fully accumulated turn.

Opaque

A well-formed provider event with no lossless canonical equivalent.

Fields

event_type: String

Provider event name, or message when the transport omitted one.

payload: Value

Complete provider payload.

Trait Implementations

impl Clone for ProviderStreamEvent

fn clone(&self) -> ProviderStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProviderStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProviderStreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ProviderStreamEvent

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 ProviderStreamEvent