Enum StreamEvent 

pub enum StreamEvent {
    Start {
        part: Part,
        kind: PartKind,
        name: Option<ToolName>,
    },
    Text {
        part: Part,
        text: String,
    },
    Reasoning {
        part: Part,
        text: String,
    },
    Arguments {
        part: Part,
        json: String,
    },
    End {
        part: Part,
        content: AssistantContent,
    },
}

One event of a completion stream: a part starts, grows, or ends with the content it finalized. Deserializing one event checks nothing about its order; read a sequence through Transcript::parse to check it.

Variants

Start

A part opened. A tool call opens once its tool is named, so a call streams its arguments under a known tool.

Fields

part: Part

The part.

kind: PartKind

What it holds.

name: Option<ToolName>

The tool a PartKind::ToolCall names as it opens; None for every other kind. The call’s end states the name it settled on.

Text

A text part grew.

Fields

part: Part

The part.

text: String

The fragment.

Reasoning

A reasoning part grew.

Fields

part: Part

The part.

text: String

The fragment.

Arguments

A tool call’s arguments grew. The fragments of one call, joined, are the argument JSON the provider sent; read an incomplete prefix with parse_partial_arguments.

Fields

part: Part

The part.

json: String

The fragment of raw argument JSON.

End

A part ended with the content it finalized.

Fields

part: Part

The part.

content: AssistantContent

The finalized content.

Implementations

impl StreamEvent

pub const fn part(&self) -> Part

The part this event is about.

pub const fn name(&self) -> &'static str

A stable variant name that exposes no payload to logs.

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> Self

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 PartialEq for StreamEvent

fn eq(&self, other: &Self) -> 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