Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    TextDelta {
        text: String,
    },
    ThinkingDelta {
        text: String,
    },
    ToolStart {
        tool_name: String,
        tool_id: String,
        args: Option<HashMap<String, Value>>,
    },
    ToolEnd {
        tool_id: String,
        success: bool,
        output: Option<String>,
        error: Option<String>,
    },
    TurnEnd,
    Error {
        message: String,
        severity: Option<Severity>,
    },
    Done {
        result: RunResult,
    },
    Raw {
        provider: CliName,
        event: Value,
    },
}

Unified stream event emitted by all adapters.

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.

TextDelta

Incremental text output.

Fields

text: String

ThinkingDelta

Incremental reasoning/thinking output.

Fields

text: String

ToolStart

A tool call has started.

Fields

tool_name: String

tool_id: String

args: Option<HashMap<String, Value>>

ToolEnd

A tool call has completed.

Fields

tool_id: String

success: bool

output: Option<String>

error: Option<String>

TurnEnd

A full agent turn has completed.

Error

An error or warning.

Fields

message: String

severity: Option<Severity>

Done

The run has completed. Contains the final result.

Fields

result: RunResult

Raw

Escape hatch for provider-specific events.

Fields

provider: CliName

event: Value

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 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.