Enum PiEvent 

pub enum PiEvent {
    AgentStart,
    AgentEnd {
        messages: Vec<PiMessage>,
    },
    TurnStart,
    TurnEnd {
        message: Box<PiMessage>,
        tool_results: Vec<PiMessage>,
    },
    MessageStart {
        message: Box<PiMessage>,
    },
    MessageUpdate {
        message: Option<Box<PiMessage>>,
        usage: Option<Usage>,
        assistant_message_event: Value,
    },
    MessageEnd {
        message: Box<PiMessage>,
    },
    ToolExecutionStart {
        tool_call_id: String,
        tool_name: String,
        args: Value,
    },
    ToolExecutionUpdate {
        tool_call_id: String,
        tool_name: String,
        args: Value,
        partial_result: Value,
    },
    ToolExecutionEnd {
        tool_call_id: String,
        tool_name: String,
        result: Value,
        is_error: bool,
    },
    Unknown {
        event_type: String,
        payload: Value,
    },
}

One event from the --mode json / --mode rpc stdout stream, discriminated on type. Known lifecycle events are typed with their primary fields lifted; every variant keeps its full payload reachable (unmodeled fields land in extra), and unknown types fall back to PiEvent::Unknown instead of erroring.

Variants

AgentStart

agent_start

AgentEnd

agent_end — carries the turn’s messages.

Fields

messages: Vec<PiMessage>

TurnStart

turn_start

TurnEnd

turn_end

Fields

message: Box<PiMessage>

tool_results: Vec<PiMessage>

MessageStart

message_start

Fields

message: Box<PiMessage>

MessageUpdate

message_update — streaming delta; in --mode json the cumulative message snapshot is omitted and only the incremental assistantMessageEvent (kept raw here) arrives.

Fields

message: Option<Box<PiMessage>>

usage: Option<Usage>

assistant_message_event: Value

MessageEnd

message_end

Fields

message: Box<PiMessage>

ToolExecutionStart

tool_execution_start

Fields

tool_call_id: String

tool_name: String

args: Value

ToolExecutionUpdate

tool_execution_update

Fields

tool_call_id: String

tool_name: String

args: Value

partial_result: Value

ToolExecutionEnd

tool_execution_end

Fields

tool_call_id: String

tool_name: String

result: Value

is_error: bool

Unknown

Any other type (session events like queue_update, compaction_start/compaction_end, bash_execution_update, extension UI requests, and whatever future CLIs add). The full object is preserved.

Fields

event_type: String

payload: Value

Implementations

impl PiEvent

pub fn event_type(&self) -> &str

The wire type string.

pub fn from_value(v: Value) -> Result<Self, Error>

Parse one stdout JSON object into a typed event.

Trait Implementations

impl Clone for PiEvent

fn clone(&self) -> PiEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PiEvent

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

Formats the value using the given formatter.

impl PartialEq for PiEvent

fn eq(&self, other: &PiEvent) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PiEvent