Enum ClientNotification 

#[non_exhaustive]
pub enum ClientNotification {
    CancelSessionNotification(Box<CancelSessionNotification>),
    MessageMcpNotification(Box<MessageMcpNotification>),
    ExtNotification(Box<ExtNotification>),
}

Available on crate feature unstable_protocol_v2 only.

All possible notifications that a client can send to an agent.

This enum is used internally for routing RPC notifications. You typically won’t need to use this directly.

Notifications do not expect a response.

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.

CancelSessionNotification(Box<CancelSessionNotification>)

Cancels ongoing operations for a session.

This is a notification sent by the client to cancel active work in a session.

Upon receiving this notification, the Agent SHOULD stop all language model requests and all tool call invocations as soon as possible.

After all ongoing operations have been successfully aborted and pending updates have been sent, the Agent MUST send an idle state_update session update with the cancelled stop reason if cancellation ended active foreground work. No additional completion update is required if no foreground work was active.

After cancellation completes, the Agent SHOULD ignore late answers rather than use them to resume the cancelled work.

Agents MUST catch errors caused by aborting cancelled work and report the cancelled stop reason, not error.

The Agent MAY send content or tool call updates after receiving session/cancel, but MUST send them before the idle state_update that reports cancellation.

See protocol docs: Cancellation

MessageMcpNotification(Box<MessageMcpNotification>)

Available on crate feature unstable_mcp_over_acp only.

UNSTABLE

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

Sends an MCP-over-ACP notification.

ExtNotification(Box<ExtNotification>)

Handles extension notifications from the client.

Extension notifications provide a way to send one-way messages for custom functionality while maintaining protocol compatibility.

See protocol docs: Extensibility

Implementations

impl ClientNotification

pub fn method(&self) -> &str

Returns the corresponding method name of the notification.

Trait Implementations

impl Clone for ClientNotification

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientNotification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ClientNotification

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 Serialize for ClientNotification

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

where __S: Serializer,

Serialize this value into the given Serde serializer.