Enum StreamEvent 

pub enum StreamEvent {
    TextDelta {
        text: String,
    },
    ToolCall {
        id: String,
        name: String,
        arguments: String,
    },
    ToolResult {
        id: String,
        result: String,
    },
    TurnComplete {
        turn: ConversationTurn,
    },
}

A stream event from an AI generation request.

Emitted by RequestBuilder::generate_stream_events, which assembles low-level provider events into this higher-level shape.

Variants

TextDelta

An incremental piece of assistant text.

Fields

text: String

Text to append to what has been received so far.

ToolCall

A tool call that has finished streaming its arguments.

Fields

id: String

Provider-assigned call identifier.

name: String

Name of the tool the model wants to run.

arguments: String

Raw JSON argument string as streamed by the provider.

ToolResult

The result of executing a tool call.

Fields

id: String

Identifier of the call this result answers.

result: String

Serialized tool output.

TurnComplete

The turn is finished; carries the assembled conversation turn.

Fields

turn: ConversationTurn

The complete turn, ready to be stored as history.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<StreamEvent> for WireStreamEvent

fn from(event: StreamEvent) -> Self

Forward a high-level StreamEvent onto the wire without loss.

Every StreamEvent has an exact counterpart here, and TryFrom<WireStreamEvent> converts it back to the same value.

impl PartialEq for StreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for StreamEvent

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 StreamEvent

impl TryFrom<WireStreamEvent> for StreamEvent

type Error = UnrepresentableWireEvent

The type returned in the event of a conversion error.

fn try_from(event: WireStreamEvent) -> Result<Self, UnrepresentableWireEvent>

Performs the conversion.