Enum WsMessage 

pub enum WsMessage {
    Snapshot {
        data: Value,
    },
    Text {
        text: String,
    },
    TextDelta {
        delta: String,
    },
    ToolExecuting {
        name: String,
        arguments: String,
    },
    ToolResult {
        name: String,
        result: String,
        is_error: bool,
    },
    Reasoning {
        text: String,
    },
    ReasoningDelta {
        delta: String,
    },
    Round {
        round: u32,
        max_rounds: u32,
        context_pct: f64,
    },
    Phase {
        phase: String,
    },
    Question {
        question: UserQuestion,
    },
    QuestionDismissed,
    Finished,
    Log {
        line: LogLine,
    },
    Extension {
        data: Value,
    },
    UserMessage {
        message: String,
    },
    TokenUsage {
        prompt_tokens: u32,
        completion_tokens: u32,
    },
    ToolCallsReceived {
        round: u32,
        count: usize,
    },
    ToolCacheHit {
        name: String,
        arguments: String,
    },
    Eviction {
        freed_chars: usize,
        evicted_count: usize,
    },
    Compaction {
        compaction_number: usize,
    },
    ModelRouted {
        model: String,
        round: u32,
    },
    CheckpointSaved {
        round: u32,
        path: String,
    },
    CheckpointResumed {
        round: u32,
    },
    EmptyResponse {
        round: u32,
        attempt: u32,
        max_retries: u32,
    },
    ApprovalRequired {
        name: String,
        arguments: String,
    },
    TodoUpdate {
        content: String,
    },
}

A message sent from the server to WebSocket clients.

Discriminated on the type field when serialized to JSON.

Variants

Snapshot

Full state snapshot (sent on initial connect and after reconnect).

Fields

data: Value

Text

Complete LLM text block.

Fields

text: String

TextDelta

Streaming token delta.

Fields

delta: String

ToolExecuting

A tool is about to execute.

Fields

name: String

arguments: String

ToolResult

A tool finished executing.

Fields

name: String

result: String

is_error: bool

Reasoning

LLM reasoning / extended thinking content.

Fields

text: String

ReasoningDelta

Streaming reasoning delta.

Fields

delta: String

Round

Round progress update.

Fields

round: u32

max_rounds: u32

context_pct: f64

Phase

Phase change.

Fields

phase: String

Question

A question has been presented to the user.

Fields

question: UserQuestion

QuestionDismissed

The active question has been resolved.

Finished

The agent finished (no more tool calls).

Log

A log line captured from tracing.

Fields

line: LogLine

Extension

Domain-specific extension state update.

Fields

data: Value

UserMessage

A user message sent from the chat UI.

Fields

message: String

TokenUsage

Token usage for the current round.

Fields

prompt_tokens: u32

completion_tokens: u32

ToolCallsReceived

The agent received tool calls this round.

Fields

round: u32

count: usize

ToolCacheHit

A tool result was served from cache.

Fields

name: String

arguments: String

Eviction

Context eviction freed memory.

Fields

freed_chars: usize

evicted_count: usize

Compaction

Context compaction completed.

Fields

compaction_number: usize

ModelRouted

Model routing selected a different model.

Fields

model: String

round: u32

CheckpointSaved

Checkpoint saved after a round.

Fields

round: u32

path: String

CheckpointResumed

Resumed from a checkpoint.

Fields

round: u32

EmptyResponse

The API returned an empty response and is retrying.

Fields

round: u32

attempt: u32

max_retries: u32

ApprovalRequired

A tool execution requires human approval.

Fields

name: String

arguments: String

TodoUpdate

Consolidated todo list update (replaces previous state in the client).

Fields

content: String

Trait Implementations

impl Clone for WsMessage

fn clone(&self) -> WsMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsMessage

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

Formats the value using the given formatter.

impl Serialize for WsMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.