Enum Message 

#[non_exhaustive]
pub enum Message {
    User {
        message: UserMessage,
    },
    Assistant {
        message: AssistantMessage,
    },
    System {
        subtype: String,
        data: Value,
    },
    Result {
        subtype: String,
        duration_ms: i64,
        duration_api_ms: i64,
        is_error: bool,
        num_turns: i32,
        session_id: String,
        total_cost_usd: Option<f64>,
        usage: Option<Value>,
        result: Option<String>,
        structured_output: Option<Value>,
        stop_reason: Option<String>,
    },
    StreamEvent {
        uuid: String,
        session_id: String,
        event: Value,
        parent_tool_use_id: Option<String>,
    },
    RateLimit {
        rate_limit_info: RateLimitInfo,
        uuid: String,
        session_id: String,
    },
    Unknown {
        msg_type: String,
        raw: Value,
    },
}

Main message type enum

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.

User

User message

Fields

message: UserMessage

Message content

Assistant

Assistant message

Fields

message: AssistantMessage

Message content

System

System message

Fields

subtype: String

Subtype of system message

data: Value

Additional data

Result

Result message indicating end of turn

Fields

subtype: String

Result subtype

duration_ms: i64

Duration in milliseconds

duration_api_ms: i64

API duration in milliseconds

is_error: bool

Whether an error occurred

num_turns: i32

Number of turns

session_id: String

Session ID

total_cost_usd: Option<f64>

Total cost in USD

usage: Option<Value>

Usage statistics

result: Option<String>

Result message

structured_output: Option<Value>

Structured output (when output_format is set) Contains the validated JSON response matching the schema

stop_reason: Option<String>

Reason the conversation stopped

StreamEvent

Stream event from the CLI

Fields

uuid: String

Unique message ID

session_id: String

Session ID

event: Value

Event data

parent_tool_use_id: Option<String>

Parent tool use ID (for subagent events)

RateLimit

Rate limit notification

Fields

rate_limit_info: RateLimitInfo

Rate limit details

uuid: String

Unique message ID

session_id: String

Session ID

Unknown

Unknown message type (forward compatibility) Not deserialized by serde — constructed by message_parser

Fields

msg_type: String

Original message type string

raw: Value

Raw JSON data

Implementations

impl Message

pub fn as_task_started(&self) -> Option<TaskStartedMessage>

Try to extract a TaskStartedMessage from a System message

pub fn as_task_progress(&self) -> Option<TaskProgressMessage>

Try to extract a TaskProgressMessage from a System message

pub fn as_task_notification(&self) -> Option<TaskNotificationMessage>

Try to extract a TaskNotificationMessage from a System message

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Message

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

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 Message