Enum StreamEvent 

pub enum StreamEvent {
    MessageStart {
        id: MessageId,
    },
    TextStart {
        id: BlockId,
    },
    TextDelta {
        id: BlockId,
        delta: SharedStr,
    },
    TextEnd {
        id: BlockId,
    },
    ThinkingStart {
        id: BlockId,
    },
    ThinkingDelta {
        id: BlockId,
        delta: SharedStr,
    },
    ThinkingEnd {
        id: BlockId,
        signature: Option<ReplaySignature>,
    },
    ToolCallStart {
        id: BlockId,
        tool_call_id: ToolCallId,
        name: ToolName,
    },
    ToolArgsDelta {
        id: BlockId,
        delta: SharedStr,
    },
    ToolCallEnd {
        id: BlockId,
    },
    UsageUpdate {
        usage: Usage,
    },
    MessageEnd {
        id: MessageId,
        stop_reason: StopReason,
        response_id: Option<String>,
    },
    ProviderWarning {
        message: SharedStr,
    },
    Error {
        error: ProviderError,
    },
}

Incremental provider output event.

Variants

MessageStart

Start of an assistant message.

Fields

id: MessageId

TextStart

Start of a text block.

Fields

id: BlockId

TextDelta

Text block delta.

Fields

id: BlockId

delta: SharedStr

TextEnd

End of a text block.

Fields

id: BlockId

ThinkingStart

Start of a thinking block.

Fields

id: BlockId

ThinkingDelta

Thinking block delta.

Fields

id: BlockId

delta: SharedStr

ThinkingEnd

End of a thinking block.

Fields

id: BlockId

signature: Option<ReplaySignature>

ToolCallStart

Start of a tool call block.

Fields

id: BlockId

tool_call_id: ToolCallId

name: ToolName

ToolArgsDelta

Tool arguments delta, usually a JSON fragment.

Fields

id: BlockId

delta: SharedStr

ToolCallEnd

End of a tool call block.

Fields

id: BlockId

UsageUpdate

Provider token usage update.

Fields

usage: Usage

MessageEnd

End of an assistant message.

Fields

id: MessageId

stop_reason: StopReason

response_id: Option<String>

The provider’s response ID, used for previous_response_id chaining.

ProviderWarning

Non-fatal warning surfaced by the provider adapter.

Fields

message: SharedStr

Error

Provider error surfaced through the stream.

Fields

error: ProviderError

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

impl JsonSchema for StreamEvent

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for StreamEvent

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