Enum WsMessageType 

pub enum WsMessageType {
    ToolCall,
    ToolResult,
    ApprovalRequired,
    ApprovalResolved,
    AskUserRequired,
    AskUserResolved,
    PlanContent,
    PlanApprovalRequired,
    PlanApprovalResolved,
    StatusUpdate,
    TaskCompleted,
    SubagentStart,
    SubagentComplete,
    ParallelAgentsStart,
    ParallelAgentsDone,
    ThinkingBlock,
    Progress,
    NestedToolCall,
    NestedToolResult,
    MessageChunk,
    MessageStart,
    MessageComplete,
    SessionActivity,
    UserMessage,
    McpStatusChanged,
    McpServersUpdated,
    Error,
    Pong,
    Query,
    Approve,
    AskUserResponse,
    PlanApprovalResponse,
    Ping,
    Interrupt,
}

All known WebSocket message types, matching the Python WSMessageType enum.

Variants are grouped into server-to-client and client-to-server.

Variants

ToolCall

A tool call is being made by the agent.

ToolResult

Result of a tool call.

ApprovalRequired

An approval is required before executing a tool.

ApprovalResolved

An approval request has been resolved.

AskUserRequired

The agent needs user input via ask-user.

AskUserResolved

An ask-user request has been resolved.

PlanContent

Plan content from the planning agent.

PlanApprovalRequired

A plan requires user approval.

PlanApprovalResolved

A plan approval request has been resolved.

StatusUpdate

Status update (mode, autonomy, thinking, etc.).

TaskCompleted

The agent has completed its task.

SubagentStart

A subagent has started execution.

SubagentComplete

A subagent has completed execution.

ParallelAgentsStart

Parallel agent execution started.

ParallelAgentsDone

Parallel agent execution completed.

ThinkingBlock

A thinking/reasoning block from the model.

Progress

Progress update during a long-running operation.

NestedToolCall

A tool call within a nested/subagent context.

NestedToolResult

Result of a nested tool call.

MessageChunk

Streaming message chunk.

MessageStart

Start of a new assistant message.

MessageComplete

Completion of an assistant message.

SessionActivity

Session activity event.

UserMessage

User message (echoed back or broadcast).

McpStatusChanged

MCP server status changed.

McpServersUpdated

MCP servers list updated.

Error

Error message.

Pong

Pong response to a ping.

Query

Query / user message from the client.

Approve

Approval response from the client.

AskUserResponse

Ask-user response from the client.

PlanApprovalResponse

Plan approval response from the client.

Ping

Ping keepalive.

Interrupt

Interrupt request.

Implementations

impl WsMessageType

pub fn as_str(&self) -> &'static str

Get the string representation matching the wire format.

pub fn from_str_opt(s: &str) -> Option<Self>

Parse a message type string into the enum.

Trait Implementations

impl Clone for WsMessageType

fn clone(&self) -> WsMessageType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsMessageType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WsMessageType

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WsMessageType

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

Formats the value using the given formatter.

impl Hash for WsMessageType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WsMessageType

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for WsMessageType

impl Eq for WsMessageType

impl StructuralPartialEq for WsMessageType