Enum SessionEventPayload 

pub enum SessionEventPayload {
    SessionStarted,
    Warning {
        message: String,
    },
    TurnStarted {
        turn_id: TurnId,
    },
    MessageItem {
        message: Message,
    },
    DeltaItem {
        delta: DeltaItem,
    },
    ToolExecutionStarted {
        call: ToolCall,
    },
    ToolOutput {
        call_id: ToolCallId,
        tool_name: ToolName,
        chunk: SharedStr,
    },
    HookStarted {
        run: HookRunSummary,
    },
    HookCompleted {
        run: HookRunSummary,
    },
    ToolExecutionCompleted {
        outcome: ToolExecutionOutcome,
    },
    ApprovalRequested {
        tool_name: ToolName,
        reason: String,
    },
    ContextCompacted {
        summary: String,
    },
    TurnCompleted {
        turn_id: TurnId,
        usage: Usage,
    },
    TurnFailed {
        turn_id: TurnId,
        error: String,
        cancelled: bool,
        retryable: bool,
    },
    Lagged {
        dropped_events: u64,
    },
    SessionShutdownComplete,
}

Event payload emitted by the session runtime.

Variants

SessionStarted

Warning

Fields

message: String

TurnStarted

Fields

turn_id: TurnId

MessageItem

Fields

message: Message

DeltaItem

Fields

delta: DeltaItem

ToolExecutionStarted

Fields

call: ToolCall

ToolOutput

Fields

call_id: ToolCallId

tool_name: ToolName

chunk: SharedStr

HookStarted

Fields

run: HookRunSummary

HookCompleted

Fields

run: HookRunSummary

ToolExecutionCompleted

Fields

outcome: ToolExecutionOutcome

ApprovalRequested

Fields

tool_name: ToolName

reason: String

ContextCompacted

Fields

summary: String

TurnCompleted

Fields

turn_id: TurnId

usage: Usage

TurnFailed

Fields

turn_id: TurnId

error: String

cancelled: bool

Whether the failure came from explicit user/runtime cancellation.

retryable: bool

Whether the underlying provider error advertised itself as retryable. Defaults to false so historical replays without this field deserialize cleanly.

Lagged

Fields

dropped_events: u64

SessionShutdownComplete

Trait Implementations

impl Clone for SessionEventPayload

fn clone(&self) -> SessionEventPayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionEventPayload

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionEventPayload

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionEventPayload

impl JsonSchema for SessionEventPayload

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for SessionEventPayload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SessionEventPayload

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 SessionEventPayload