Enum SessionUpdate 

#[non_exhaustive]
pub enum SessionUpdate {
    UserMessageChunk(ContentChunk),
    UserMessage(UserMessage),
    AgentMessageChunk(ContentChunk),
    AgentMessage(AgentMessage),
    AgentThoughtChunk(ContentChunk),
    AgentThought(AgentThought),
    StateUpdate(StateUpdate),
    ToolCallContentChunk(ToolCallContentChunk),
    ToolCallUpdate(ToolCallUpdate),
    TerminalUpdate(TerminalUpdate),
    TerminalOutputChunk(TerminalOutputChunk),
    PlanUpdate(PlanUpdate),
    PlanRemoved(PlanRemoved),
    AvailableCommandsUpdate(AvailableCommandsUpdate),
    ConfigOptionUpdate(ConfigOptionUpdate),
    SessionInfoUpdate(SessionInfoUpdate),
    UsageUpdate(UsageUpdate),
    Other(OtherSessionUpdate),
}

Available on crate feature unstable_protocol_v2 only.

Different types of updates that can be sent while a session exists.

These updates report messages, progress, and other session activity.

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.

UserMessage(UserMessage)

A user message has been created or updated.

Agents can send this when they accept or replay a user message. When a client receives another user_message update with the same messageId, fields in the new update patch the previous fields for that message.

AgentMessageChunk(ContentChunk)

A chunk of the agent’s response being streamed.

AgentMessage(AgentMessage)

An agent message has been created or updated.

Agents can send this in addition to streamed chunks. When a client receives another agent_message update with the same messageId, fields in the new update patch the previous fields for that message.

AgentThoughtChunk(ContentChunk)

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

AgentThought(AgentThought)

An agent thought or reasoning message has been created or updated.

Agents can send this in addition to streamed chunks. When a client receives another agent_thought update with the same messageId, fields in the new update patch the previous fields for that message.

StateUpdate(StateUpdate)

The state of the agent’s foreground work has changed.

ToolCallContentChunk(ToolCallContentChunk)

A chunk of tool-call content being streamed.

ToolCallUpdate(ToolCallUpdate)

A tool call has been created or updated.

TerminalUpdate(TerminalUpdate)

An agent-owned terminal has been created or updated.

TerminalOutputChunk(TerminalOutputChunk)

A chunk of bytes appended to an agent-owned terminal’s output.

PlanUpdate(PlanUpdate)

A content update for a plan identified by ID. See protocol docs: Agent Plan

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

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.

Other(OtherSessionUpdate)

Custom or future session update.

Values beginning with _ are reserved for implementation-specific extensions. Unknown values that do not begin with _ are reserved for future ACP variants.

Receivers that do not understand this update type should preserve the raw payload when storing, replaying, proxying, or forwarding session history, and otherwise ignore it or display it generically.

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

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

impl TryFrom<SessionUpdate> for SessionUpdate

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from(value: SessionUpdate) -> Result<Self>

Performs the conversion.

impl TryFrom<SessionUpdate> for Vec<SessionUpdate>

type Error = ProtocolConversionError

The type returned in the event of a conversion error.

fn try_from(value: SessionUpdate) -> Result<Self>

Performs the conversion.