Enum MessageEvent 

#[non_exhaustive]
pub enum MessageEvent {
    TextChunk {
        text: String,
    },
    ToolUse {
        id: String,
        name: String,
        input: Value,
    },
    ToolResult {
        tool_use_id: String,
        success: bool,
        output: String,
    },
    ApiRetry {
        attempt: u32,
        message: String,
    },
    RateLimit {
        message: String,
    },
    Thinking {
        text: String,
    },
    ResultDone {
        cost: AgentCost,
        content: String,
        is_error: bool,
    },
    Error {
        message: String,
    },
}

Event emitted by a streaming query.

#[non_exhaustive] — new variants may be added in minor versions.

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.

TextChunk

A chunk of assistant text content.

Fields

text: String

ToolUse

The model started a tool call.

Fields

id: String

name: String

input: Value

ToolResult

A tool finished executing.

Fields

tool_use_id: String

success: bool

output: String

ApiRetry

Provider is retrying an API request.

Fields

attempt: u32

message: String

RateLimit

Upstream rate limit notification.

Fields

message: String

Thinking

Extended-thinking content (Claude only).

Fields

text: String

ResultDone

Terminal event: the query is done. Contains final cost.

Fields

cost: AgentCost

content: String

is_error: bool

Error

Terminal event: the query failed.

Fields

message: String

Trait Implementations

impl Clone for MessageEvent

fn clone(&self) -> MessageEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MessageEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MessageEvent

fn deserialize<__D>( __deserializer: __D, ) -> Result<MessageEvent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MessageEvent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.