Struct StreamEvent 

pub struct StreamEvent {
    pub data: Value,
}

A single line from --output-format stream-json output.

Each line is an NDJSON object. The structure varies by message type, so we provide the raw JSON value and convenience accessors.

Fields

data: Value

The raw JSON object for this event.

Implementations

impl StreamEvent

pub fn event_type(&self) -> Option<&str>

Get the event type, if present.

pub fn role(&self) -> Option<&str>

Get the message role, if present.

pub fn is_result(&self) -> bool

Check if this is the final result message.

pub fn result_text(&self) -> Option<&str>

Extract the result text from a result event.

pub fn session_id(&self) -> Option<&str>

Get the session ID if present.

pub fn cost_usd(&self) -> Option<f64>

Get the cost in USD if present (usually on result events).

Prefers total_cost_usd (the CLI’s primary key) and falls back to the legacy cost_usd alias.

pub fn partial_message(&self) -> Option<PartialMessageEvent>

Decode a partial-message event into a typed view.

Returns Some when the event is one of the content-block lifecycle events surfaced by QueryCommand::include_partial_messages – start, delta, or stop. Returns None for any other event (system, assistant, result, message-level stream events, etc).

The CLI wraps each raw streaming event as {"type":"stream_event","event":{...}}; this accessor unwraps that envelope. Unknown block types and unknown delta types fall through to BlockType::Other / BlockDelta::Other rather than erroring, so future content-block kinds remain accessible (just untyped).

Example

Pull incremental thinking text out of a partial-message event:

use claude_wrapper::streaming::{BlockDelta, PartialMessageEvent, StreamEvent};
use serde_json::json;

let event: StreamEvent = serde_json::from_value(json!({
    "type": "stream_event",
    "event": {
        "type": "content_block_delta",
        "index": 0,
        "delta": { "type": "thinking_delta", "thinking": "Let me think..." }
    },
    "session_id": "abc"
})).unwrap();

match event.partial_message() {
    Some(PartialMessageEvent::BlockDelta { delta: BlockDelta::Thinking(t), .. }) => {
        assert_eq!(t, "Let me think...");
    }
    _ => unreachable!(),
}

Trait Implementations

impl Clone for StreamEvent

fn clone(&self) -> StreamEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StreamEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.