Enum ServerMessage 

pub enum ServerMessage {
    Ack(AckPayload),
    RunEvent(RunEventPayload),
    RunLog(RunLogPayload),
    Assistant(AssistantPayload),
    Thinking(ThinkingPayload),
    ToolUse(ToolUsePayload),
    ToolResult(ToolResultPayload),
    Cost(CostPayload),
    Status(StatusPayload),
    Error(ErrorPayload),
    McpNotification(McpNotificationPayload),
    Skill(SkillPayload),
    Evolution(EvolutionPayload),
    Injected(InjectedPayload),
    Retry(RetryPayload),
}

Outgoing message from server to client. Tagged by "type" — each variant carries only its own typed fields.

Variants

Ack(AckPayload)

Immediate acknowledgement that a valid client input frame was received.

RunEvent(RunEventPayload)

RunLog(RunLogPayload)

Assistant(AssistantPayload)

AI assistant response text

Thinking(ThinkingPayload)

AI thinking/reasoning content (separate from assistant response)

ToolUse(ToolUsePayload)

Tool execution notification (AI intends to use tool)

ToolResult(ToolResultPayload)

Tool execution result (after execution)

Cost(CostPayload)

Cost and token usage information

Status(StatusPayload)

Status/info message (non-critical)

Error(ErrorPayload)

Error message

McpNotification(McpNotificationPayload)

Notification received from an MCP server (e.g. progress, log messages)

Skill(SkillPayload)

Skill lifecycle event (activate / use / forget) — emitted for structured output

Evolution(EvolutionPayload)

Generated behavior lifecycle event (candidate / trial / promote / rollback).

Injected(InjectedPayload)

A message injected into the session loop by a non-user source (scheduled timer, background agent, skill, …). Emitted just before the AI processes it so clients can render the trigger.

Retry(RetryPayload)

A provider call is being retried after a transient failure. Mid-turn progress, never a turn boundary (see RetryPayload).

Implementations

impl ServerMessage

pub fn error(message: String) -> Self

pub fn error_for_request(message: String, request_id: Option<String>) -> Self

pub fn ack(client_msg: &ClientMessage) -> Self

pub fn status(message: String, session_id: Option<String>) -> Self

pub fn command_status( message: String, session_id: Option<String>, data: Value, ) -> Self

A command-completion status. Unlike status() (which is also used for the connection handshake), this carries data — clients distinguish a finished command from a data-less handshake ack purely by the presence of data. Without it, an interactive /done (and any plain Handled command) is misread as the handshake and the client hangs on “working” because the turn never finalizes.

pub fn skill( action: impl Into<String>, name: impl Into<String>, trigger: Option<String>, session_id: impl Into<String>, ) -> Self

pub fn evolution( action: impl Into<String>, id: impl Into<String>, name: impl Into<String>, kind: impl Into<String>, state: impl Into<String>, scope: Value, session_id: impl Into<String>, ) -> Self

pub fn retry(event: &RetryEvent, session_id: Option<String>) -> Self

The notice for one provider retry (see RetryPayload).

Trait Implementations

impl Clone for ServerMessage

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerMessage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ServerMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ServerMessage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.