Enum AgentMessage 

pub enum AgentMessage {
    Text {
        message_id: String,
        chunk: String,
        is_complete: bool,
        model_name: String,
    },
    Thought {
        message_id: String,
        chunk: String,
        is_complete: bool,
        model_name: String,
    },
    ToolCall {
        request: ToolCallRequest,
        model_name: String,
    },
    ToolCallUpdate {
        tool_call_id: String,
        chunk: String,
        model_name: String,
    },
    ToolProgress {
        request: ToolCallRequest,
        progress: f64,
        total: Option<f64>,
        message: Option<String>,
    },
    ToolResult {
        result: ToolCallResult,
        result_meta: Option<ToolResultMeta>,
        model_name: String,
    },
    ToolError {
        error: ToolCallError,
        model_name: String,
    },
    Error {
        message: String,
    },
    Cancelled {
        message: String,
    },
    ContextCompactionStarted {
        message_count: usize,
    },
    ContextCompactionResult {
        summary: String,
        messages_removed: usize,
    },
    ContextUsageUpdate {
        usage_ratio: Option<f64>,
        context_limit: Option<u32>,
        input_tokens: u32,
        output_tokens: u32,
        cache_read_tokens: Option<u32>,
        cache_creation_tokens: Option<u32>,
        reasoning_tokens: Option<u32>,
        total_input_tokens: u64,
        total_output_tokens: u64,
        total_cache_read_tokens: u64,
        total_cache_creation_tokens: u64,
        total_reasoning_tokens: u64,
    },
    AutoContinue {
        attempt: u32,
        max_attempts: u32,
    },
    ModelSwitched {
        previous: String,
        new: String,
    },
    ContextCleared,
    Done,
}

Message from the agent to the user.

Variants

Text

Fields

message_id: String

chunk: String

is_complete: bool

model_name: String

Thought

Fields

message_id: String

chunk: String

is_complete: bool

model_name: String

ToolCall

Fields

request: ToolCallRequest

model_name: String

ToolCallUpdate

Fields

tool_call_id: String

chunk: String

model_name: String

ToolProgress

Fields

request: ToolCallRequest

progress: f64

total: Option<f64>

message: Option<String>

ToolResult

Fields

result: ToolCallResult

result_meta: Option<ToolResultMeta>

model_name: String

ToolError

Fields

error: ToolCallError

model_name: String

Error

Fields

message: String

Cancelled

Fields

message: String

ContextCompactionStarted

Context compaction has been triggered.

Fields

message_count: usize

ContextCompactionResult

Context was compacted to reduce token usage.

Fields

summary: String

messages_removed: usize

ContextUsageUpdate

Context usage update for UI display.

Fields

usage_ratio: Option<f64>

Current usage ratio (0.0 - 1.0), if context window is known.

context_limit: Option<u32>

Maximum context limit, if known.

input_tokens: u32

Input tokens on the most recent API call (the current context size).

output_tokens: u32

Output tokens on the most recent API call.

cache_read_tokens: Option<u32>

Prompt tokens served from cache on the most recent API call.

cache_creation_tokens: Option<u32>

Prompt tokens written to cache on the most recent API call.

reasoning_tokens: Option<u32>

Reasoning tokens spent on the most recent API call.

total_input_tokens: u64

Cumulative input tokens since the agent started.

total_output_tokens: u64

Cumulative output tokens since the agent started.

total_cache_read_tokens: u64

Cumulative cache-read tokens since the agent started.

total_cache_creation_tokens: u64

Cumulative cache-creation tokens since the agent started.

total_reasoning_tokens: u64

Cumulative reasoning tokens since the agent started.

AutoContinue

Agent is auto-continuing because LLM stopped with a resumable stop reason.

Fields

attempt: u32

Current attempt number (1-indexed).

max_attempts: u32

Maximum allowed attempts.

ModelSwitched

The model was successfully switched.

Fields

previous: String

new: String

ContextCleared

The agent context was cleared and reset to its blank state.

Done

Implementations

impl AgentMessage

pub fn text( message_id: &str, chunk: &str, is_complete: bool, model_name: &str, ) -> Self

pub fn thought( message_id: &str, chunk: &str, is_complete: bool, model_name: &str, ) -> Self

Trait Implementations

impl Clone for AgentMessage

fn clone(&self) -> AgentMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AgentMessage> for SubAgentEvent

fn from(msg: &AgentMessage) -> Self

Converts to this type from the input type.

impl PartialEq for AgentMessage

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

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 AgentMessage