Enum SessionUpdate 

#[non_exhaustive]
pub enum SessionUpdate {
    UserMessageChunk(ContentChunk),
    AgentMessageChunk(ContentChunk),
    AgentThoughtChunk(ContentChunk),
    ToolCall(ToolCall),
    ToolCallUpdate(ToolCallUpdate),
    Plan(Plan),
    PlanUpdate(PlanUpdate),
    PlanRemoved(PlanRemoved),
    AvailableCommandsUpdate(AvailableCommandsUpdate),
    CurrentModeUpdate(CurrentModeUpdate),
    ConfigOptionUpdate(ConfigOptionUpdate),
    SessionInfoUpdate(SessionInfoUpdate),
    UsageUpdate(UsageUpdate),
    CompactionUpdate(CompactionUpdate),
    CompactionSummaryChunk(CompactionSummaryChunk),
}

Different types of updates that can be sent during session processing.

These updates provide real-time feedback about the agent’s progress.

See protocol docs: Agent Reports Output

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UserMessageChunk(ContentChunk)

A chunk of the user’s message being streamed.

AgentMessageChunk(ContentChunk)

A chunk of the agent’s response being streamed.

AgentThoughtChunk(ContentChunk)

A chunk of the agent’s internal reasoning being streamed.

ToolCall(ToolCall)

Notification that a new tool call has been initiated.

ToolCallUpdate(ToolCallUpdate)

Update on the status or results of a tool call.

Plan(Plan)

The agent’s execution plan for complex tasks. See protocol docs: Agent Plan

PlanUpdate(PlanUpdate)

Available on crate feature unstable_plan_operations only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A content update for a plan identified by ID.

PlanRemoved(PlanRemoved)

Available on crate feature unstable_plan_operations only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Removal notice for a plan identified by ID.

AvailableCommandsUpdate(AvailableCommandsUpdate)

Available commands are ready or have changed

CurrentModeUpdate(CurrentModeUpdate)

The current mode of the session has changed

See protocol docs: Session Modes

ConfigOptionUpdate(ConfigOptionUpdate)

Session configuration options have been updated.

SessionInfoUpdate(SessionInfoUpdate)

Session metadata has been updated (title, timestamps, custom metadata)

UsageUpdate(UsageUpdate)

Context window and cost update for the session.

CompactionUpdate(CompactionUpdate)

Available on crate feature unstable_session_compaction only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A context compaction has been created or updated.

Agents MUST only send this update when the Client advertised ClientSessionCapabilities::compaction.

CompactionSummaryChunk(CompactionSummaryChunk)

Available on crate feature unstable_session_compaction only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

A content block appended to a context compaction’s retained summary.

Agents MUST only send this update when the Client advertised ClientSessionCapabilities::compaction.

Trait Implementations

impl Clone for SessionUpdate

fn clone(&self) -> SessionUpdate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionUpdate

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionUpdate

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SessionUpdate

Available on crate feature schemars only.

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SessionUpdate

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for SessionUpdate

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 SessionUpdate