Struct SdkOutput 

pub struct SdkOutput {

    pub msg_type: String,
    pub subtype: Option<String>,
    pub session_id: Option<String>,
    pub uuid: Option<String>,
    pub message: Option<Value>,
    pub event: Option<Value>,
    pub result: Option<String>,
    pub num_turns: Option<u32>,
    pub is_error: Option<bool>,
    pub errors: Option<Vec<String>>,
    pub usage: Option<Value>,
    pub model_usage: Option<Value>,
    pub request_id: Option<String>,
    pub request: Option<Value>,
}

A single NDJSON message received from Claude Code’s stdout.

Uses a flat struct with optional fields rather than a tagged enum so that unknown or new message types are silently tolerated (future-proof).

Fields

msg_type: String

subtype: Option<String>

session_id: Option<String>

uuid: Option<String>

message: Option<Value>

For assistant messages: the full message object with content array.

event: Option<Value>

For stream_event messages: the stream event payload.

result: Option<String>

For result messages: the final text result.

num_turns: Option<u32>

For result messages: number of API turns taken.

is_error: Option<bool>

For result messages: whether an error occurred.

errors: Option<Vec<String>>

For result error messages: list of error strings.

usage: Option<Value>

For result messages: usage counters for the completed turn.

model_usage: Option<Value>

For result messages: model-specific metadata.

request_id: Option<String>

For control_request messages: the request ID to echo in responses.

request: Option<Value>

For control_request messages: the request payload.

Implementations

impl SdkOutput

pub fn request_subtype(&self) -> Option<String>

Extract the subtype from a nested request object (for control requests).

pub fn request_tool_use_id(&self) -> Option<String>

Extract the tool_use_id from a can_use_tool control request.

pub fn model_name(&self) -> Option<String>

pub fn token_usage(&self) -> Option<SdkTokenUsage>

pub fn usage_total_tokens(&self) -> u64

Trait Implementations

impl Debug for SdkOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SdkOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.