Enum StreamEvent

pub enum StreamEvent {
    MessagePart {
        content: String,
        message_id: String,
    },
    MessageComplete {
        message: Message,
        usage: Option<Usage>,
        metadata: HashMap<String, String>,
        model: Model,
    },
    ToolCallStarted {
        tool_call: ToolCall,
        metadata: HashMap<String, String>,
        model: Model,
    },
    ToolCallCompleted {
        tool_call_id: String,
        result: ToolResult,
        metadata: HashMap<String, String>,
        model: Model,
    },
    ToolCallFailed {
        tool_call_id: String,
        error: String,
        metadata: HashMap<String, String>,
        model: Model,
    },
    ToolApprovalRequired {
        tool_call: ToolCall,
        timeout_ms: Option<u64>,
        metadata: HashMap<String, String>,
    },
    SessionCreated {
        session_id: String,
        metadata: SessionMetadata,
    },
    SessionResumed {
        session_id: String,
        event_offset: u64,
    },
    SessionSaved {
        session_id: String,
    },
    OperationStarted {
        operation_id: Uuid,
        operation: Operation,
    },
    OperationCompleted {
        operation_id: Uuid,
        outcome: OperationOutcome,
    },
    OperationCancelled {
        operation_id: Uuid,
        reason: String,
    },
    Error {
        message: String,
        error_type: ErrorType,
    },
    WorkspaceChanged,
    WorkspaceFiles {
        files: Vec<String>,
    },
}

Unified event type for external consumers

Variants

MessagePart

Fields

content: String

message_id: String

MessageComplete

Fields

message: Message

usage: Option<Usage>

metadata: HashMap<String, String>

model: Model

ToolCallStarted

Fields

tool_call: ToolCall

metadata: HashMap<String, String>

model: Model

ToolCallCompleted

Fields

tool_call_id: String

result: ToolResult

metadata: HashMap<String, String>

model: Model

ToolCallFailed

Fields

tool_call_id: String

error: String

metadata: HashMap<String, String>

model: Model

ToolApprovalRequired

Fields

tool_call: ToolCall

timeout_ms: Option<u64>

metadata: HashMap<String, String>

SessionCreated

Fields

session_id: String

metadata: SessionMetadata

SessionResumed

Fields

session_id: String

event_offset: u64

SessionSaved

Fields

session_id: String

OperationStarted

Fields

operation_id: Uuid

operation: Operation

OperationCompleted

Fields

operation_id: Uuid

outcome: OperationOutcome

OperationCancelled

Fields

operation_id: Uuid

reason: String

Error

Fields

message: String

error_type: ErrorType

WorkspaceChanged

WorkspaceFiles

Fields

files: Vec<String>

Implementations

impl StreamEvent

pub fn is_error(&self) -> bool

Check if this event indicates an error condition

pub fn operation_id(&self) -> Option<&Uuid>

Get the operation ID if this event relates to an operation

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

Get the session ID if this event relates to a session

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

Get the tool call ID if this event relates to a tool call

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

Get the message ID if this event relates to a message

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.