Enum RuntimeEvent 

pub enum RuntimeEvent {
    TextDelta {
        session_id: SessionId,
        text: String,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    ThoughtDelta {
        session_id: SessionId,
        text: String,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    ToolCallDraft {
        session_id: SessionId,
        index: usize,
        name: String,
        args_len: usize,
        count: usize,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    ToolCallStarted {
        session_id: SessionId,
        tool_name: String,
        args_json: String,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    ToolCallFinished {
        session_id: SessionId,
        tool_name: String,
        summary: String,
        agent_id: Option<String>,
        trace_id: Option<String>,
        denied: bool,
        details: Option<Value>,
    },
    AwaitingApproval {
        session_id: SessionId,
        request: ApprovalRequest,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    Checkpoint {
        session_id: SessionId,
        checkpoint: CheckpointData,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    RunFinished {
        session_id: SessionId,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    RunCancelled {
        session_id: SessionId,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    PlanUpdated {
        session_id: SessionId,
        objective: String,
        explanation: Option<String>,
        plan: Vec<PlanItem>,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
    UserEvent {
        session_id: SessionId,
        event: UserEvent,
        agent_id: Option<String>,
        trace_id: Option<String>,
    },
}

Unified runtime event — the single event type for both internal and external consumers (frontends, CLIs, tests).

Variants

TextDelta

Fields

session_id: SessionId

text: String

agent_id: Option<String>

Identifies the agent that produced this event (root / sub-agent path).

trace_id: Option<String>

Distributed tracing context carried across systems (e.g. MCP caller → phi-agent).

ThoughtDelta

Fields

session_id: SessionId

text: String

agent_id: Option<String>

trace_id: Option<String>

ToolCallDraft

A tool call that is still being streamed into existence.

Tool-call arguments arrive as fragments and are only materialized into a RuntimeEvent::ToolCallStarted once the whole turn’s stream is drained — multi-KB arguments (a spawn_agent task brief) are invisible to every consumer until then. This event makes that window observable: coarse progress on the call being drafted (index), enough for a UI to say “writing tool calls” instead of looking hung. It carries no argument text, only a size, and is throttled at the source.

Fields

session_id: SessionId

index: usize

The call’s stream index within this turn (its eventual tool-call id is not known yet).

name: String

Function name, empty until the fragment carrying it arrives.

args_len: usize

Argument characters accumulated for this call so far.

count: usize

How many calls this turn has produced so far (drafts included).

agent_id: Option<String>

trace_id: Option<String>

ToolCallStarted

Fields

session_id: SessionId

tool_name: String

args_json: String

agent_id: Option<String>

trace_id: Option<String>

ToolCallFinished

Fields

session_id: SessionId

tool_name: String

summary: String

agent_id: Option<String>

trace_id: Option<String>

denied: bool

true when this finish is the result of an approval denial (not a normal tool result or execution error).

details: Option<Value>

Structured metadata from the tool result (e.g. edit line numbers). Carried through to UI consumers; never sent to the LLM.

AwaitingApproval

Fields

session_id: SessionId

request: ApprovalRequest

agent_id: Option<String>

trace_id: Option<String>

Checkpoint

Fields

session_id: SessionId

checkpoint: CheckpointData

agent_id: Option<String>

trace_id: Option<String>

RunFinished

Fields

session_id: SessionId

agent_id: Option<String>

trace_id: Option<String>

RunCancelled

Fields

session_id: SessionId

agent_id: Option<String>

trace_id: Option<String>

PlanUpdated

Fields

session_id: SessionId

objective: String

explanation: Option<String>

plan: Vec<PlanItem>

agent_id: Option<String>

trace_id: Option<String>

UserEvent

A user-space event produced by a tool.

Fields

session_id: SessionId

event: UserEvent

agent_id: Option<String>

trace_id: Option<String>

Implementations

impl RuntimeEvent

pub fn session_id(&self) -> &SessionId

Get the session ID associated with this event.

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

Get the agent ID associated with this event, if any.

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

Get the trace ID associated with this event, if any.

pub fn with_agent_id(self, id: impl Into<String>) -> Self

Set the agent ID (sub-agent path) on this event.

Trait Implementations

impl Clone for RuntimeEvent

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuntimeEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for RuntimeEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.