Enum AgentSessionEvent 

pub enum AgentSessionEvent {
    SessionBeforeSwitch {
        reason: SessionBeforeSwitchReason,
        target_session_file: Option<String>,
    },
    SessionBeforeFork {
        entry_id: String,
        position: SessionBeforeForkPosition,
    },
    SessionStart {
        reason: SessionStartReason,
        previous_session_file: Option<String>,
    },
    SessionShutdown {
        reason: SessionShutdownReason,
        target_session_file: Option<String>,
    },
    ModelSelect {
        model: Box<Model>,
        previous_model: Option<Box<Model>>,
        source: ModelSelectSource,
    },
    AgentStart,
    AgentEnd {
        messages: Vec<AgentMessage>,
        will_retry: bool,
    },
    TurnStart,
    TurnEnd {
        message: AgentMessage,
        tool_results: Vec<ToolResultMessage>,
    },
    MessageStart {
        message: AgentMessage,
    },
    MessageUpdate {
        message: AgentMessage,
        assistant_message_event: Box<AssistantMessageEvent>,
    },
    MessageEnd {
        message: AgentMessage,
    },
    ToolExecutionStart {
        tool_call_id: String,
        tool_name: String,
        args: Map<String, Value>,
    },
    ToolExecutionUpdate {
        tool_call_id: String,
        tool_name: String,
        args: Map<String, Value>,
        partial_result: AgentToolResult,
    },
    ToolExecutionEnd {
        tool_call_id: String,
        tool_name: String,
        result: AgentToolResult,
        is_error: bool,
    },
    AgentSettled,
    QueueUpdate {
        steering: Vec<String>,
        follow_up: Vec<String>,
    },
    CompactionStart {
        reason: CompactionReason,
    },
    CompactionEnd {
        reason: CompactionReason,
        result: Option<CompactionResult>,
        aborted: bool,
        will_retry: bool,
        error_message: Option<String>,
    },
    EntryAppended {
        entry: SessionEntry,
    },
    SessionInfoChanged {
        name: Option<String>,
    },
    ThinkingLevelChanged {
        level: ModelThinkingLevel,
    },
    AutoRetryStart {
        attempt: u32,
        max_attempts: u32,
        delay_ms: u64,
        error_message: String,
    },
    AutoRetryEnd {
        success: bool,
        attempt: u32,
        final_error: Option<String>,
    },
}

Session-specific events that extend the core agent event surface.

Wire tags and field names match TypeScript AgentSessionEvent.

Variants

SessionBeforeSwitch

Extensions may cancel a pending session switch.

Fields

reason: SessionBeforeSwitchReason

Whether this creates a new session or resumes one.

target_session_file: Option<String>

Target session file for resume/import operations.

SessionBeforeFork

Extensions may cancel a pending session fork.

Fields

entry_id: String

Selected session entry.

position: SessionBeforeForkPosition

Whether the fork starts before or at the selected entry.

SessionStart

Extension-host-facing session start (never routed through emit_public; the public event stream excludes it, matching TS).

Fields

reason: SessionStartReason

Why this session started.

previous_session_file: Option<String>

Previously active session file (new/resume/fork).

SessionShutdown

Extension-host-facing session shutdown (never routed through emit_public).

Fields

reason: SessionShutdownReason

Why this session is shutting down.

target_session_file: Option<String>

Session file replacing this one (new/resume/fork).

ModelSelect

A new model was selected.

Fields

model: Box<Model>

Newly selected model (boxed to keep the enum small; wire unchanged).

previous_model: Option<Box<Model>>

Previously selected model, absent during initial restoration.

source: ModelSelectSource

Selection source.

AgentStart

A new agent run has started.

AgentEnd

The agent run finished; will_retry is true when auto-retry will continue.

Fields

messages: Vec<AgentMessage>

Messages produced by this run.

will_retry: bool

Whether session-level auto-retry will continue the run.

TurnStart

A turn is about to begin.

TurnEnd

A turn finished with an assistant message and any tool results.

Fields

message: AgentMessage

Assistant message that completed the turn.

tool_results: Vec<ToolResultMessage>

Tool-result messages for this turn.

MessageStart

A transcript message is starting.

Fields

message: AgentMessage

Message snapshot at start.

MessageUpdate

An assistant message was updated during streaming.

Fields

message: AgentMessage

Latest assistant message snapshot.

assistant_message_event: Box<AssistantMessageEvent>

Underlying provider stream event.

MessageEnd

A transcript message has ended.

Fields

message: AgentMessage

Final message snapshot.

ToolExecutionStart

Tool execution is starting for one tool call.

Fields

tool_call_id: String

Tool-call identifier.

tool_name: String

Registered tool name.

args: Map<String, Value>

Validated tool arguments.

ToolExecutionUpdate

Tool execution produced a partial result update.

Fields

tool_call_id: String

Tool-call identifier.

tool_name: String

Registered tool name.

args: Map<String, Value>

Validated tool arguments.

partial_result: AgentToolResult

Partial tool result.

ToolExecutionEnd

Tool execution finished for one tool call.

Fields

tool_call_id: String

Tool-call identifier.

tool_name: String

Registered tool name.

result: AgentToolResult

Final tool result.

is_error: bool

Whether the result is treated as an error.

AgentSettled

Session-level idle after retries / compaction / queued continuations.

QueueUpdate

Mirror of pending steering / follow-up queue text for UI.

Fields

steering: Vec<String>

Pending steering message texts.

follow_up: Vec<String>

Pending follow-up message texts.

CompactionStart

Compaction is starting.

Fields

reason: CompactionReason

Why compaction was triggered.

CompactionEnd

Compaction finished.

Fields

reason: CompactionReason

Why compaction was triggered.

result: Option<CompactionResult>

Result when compaction produced a summary.

aborted: bool

Whether compaction was aborted.

will_retry: bool

Whether the session will retry after this compaction.

error_message: Option<String>

Error text when compaction failed.

EntryAppended

A session entry was appended.

Fields

entry: SessionEntry

Appended entry.

SessionInfoChanged

Session display name changed.

Fields

name: Option<String>

New name (None clears).

ThinkingLevelChanged

Thinking level changed.

Fields

level: ModelThinkingLevel

New thinking level.

AutoRetryStart

Auto-retry backoff is starting.

Fields

attempt: u32

Current attempt (1-based).

max_attempts: u32

Configured max attempts.

delay_ms: u64

Backoff delay in milliseconds.

error_message: String

Error that triggered the retry.

AutoRetryEnd

Auto-retry finished (success, exhaustion, or cancel).

Fields

success: bool

Whether a later assistant response succeeded.

attempt: u32

Attempt count at end.

final_error: Option<String>

Final error when unsuccessful.

Implementations

impl AgentSessionEvent

pub fn from_agent_event(event: AgentEvent, will_retry: bool) -> Self

Convert a core agent event into a session event.

agent_end requires will_retry from the session retry policy.

pub fn type_name(&self) -> &'static str

Wire type discriminant.

Trait Implementations

impl Clone for AgentSessionEvent

fn clone(&self) -> AgentSessionEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AgentSessionEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentSessionEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AgentSessionEvent

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AgentSessionEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AgentSessionEvent