Enum ChatStreamEvent 

#[non_exhaustive]
pub enum ChatStreamEvent {
    Started {
        provider: ProviderId,
        model: ModelName,
    },
    TextDelta {
        delta: String,
    },
    ToolCallStarted {
        id: String,
        name: String,
    },
    ToolCallArgumentsDelta {
        id: String,
        delta: String,
    },
    ToolCallCompleted {
        call: ToolCall,
    },
    Finished {
        finish_reason: FinishReason,
        usage: Option<TokenUsage>,
    },
}

Event emitted by a streaming chat provider.

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.

Started

Stream has started.

Fields

provider: ProviderId

Provider serving the stream.

model: ModelName

Model serving the stream.

TextDelta

Text delta produced by the model.

Fields

delta: String

Incremental text chunk.

ToolCallStarted

Tool call has started.

Fields

id: String

Provider-generated call identifier.

name: String

Tool name requested by the model.

ToolCallArgumentsDelta

Tool call argument JSON delta.

Fields

id: String

Provider-generated call identifier.

delta: String

Incremental argument chunk.

ToolCallCompleted

Tool call has completed and can be executed.

Fields

call: ToolCall

Completed tool call.

Finished

Stream has finished.

Fields

finish_reason: FinishReason

Reason the provider stopped generation.

usage: Option<TokenUsage>

Token accounting, when supplied by the provider.

Trait Implementations

impl Clone for ChatStreamEvent

fn clone(&self) -> ChatStreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChatStreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatStreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ChatStreamEvent

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ChatStreamEvent

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 ChatStreamEvent