Enum SessionUpdate 

#[non_exhaustive]
pub enum SessionUpdate {
    UserMessageChunk(ContentChunk),
    AgentMessageChunk(ContentChunk),
    AgentThoughtChunk(ContentChunk),
    ToolCall(ToolCall),
    ToolCallUpdate(ToolCallUpdate),
    PlanUpdate(PlanUpdate),
    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 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.

PlanUpdate(PlanUpdate)

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

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionUpdate, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV1 for SessionUpdate

type Output = SessionUpdate

The corresponding v1 type.

fn into_v1( self, ) -> Result<<SessionUpdate as IntoV1>::Output, ProtocolConversionError>

Converts this value into the corresponding v1 type.

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

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 SessionUpdate

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionUpdate