Enum ClientNotification 

#[non_exhaustive]
pub enum ClientNotification {
    CancelNotification(CancelNotification),
    DidOpenDocumentNotification(DidOpenDocumentNotification),
    DidChangeDocumentNotification(DidChangeDocumentNotification),
    DidCloseDocumentNotification(DidCloseDocumentNotification),
    DidSaveDocumentNotification(DidSaveDocumentNotification),
    DidFocusDocumentNotification(DidFocusDocumentNotification),
    AcceptNesNotification(AcceptNesNotification),
    RejectNesNotification(RejectNesNotification),
    MessageMcpNotification(MessageMcpNotification),
    ExtNotification(ExtNotification),
}

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.

CancelNotification(CancelNotification)

Cancels ongoing operations for a session.

This is a notification sent by the client to cancel an ongoing prompt turn.

Upon receiving this notification, the Agent SHOULD:

• Stop all language model requests as soon as possible
• Abort all tool call invocations in progress
• Send any pending session/update notifications
• Respond to the original session/prompt request with StopReason::Cancelled

See protocol docs: Cancellation

DidOpenDocumentNotification(DidOpenDocumentNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a file is opened in the editor.

DidChangeDocumentNotification(DidChangeDocumentNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a file is edited.

DidCloseDocumentNotification(DidCloseDocumentNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a file is closed.

DidSaveDocumentNotification(DidSaveDocumentNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a file is saved.

DidFocusDocumentNotification(DidFocusDocumentNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a file becomes the active editor tab.

AcceptNesNotification(AcceptNesNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a suggestion is accepted.

RejectNesNotification(RejectNesNotification)

Available on crate feature unstable_nes only.

UNSTABLE

Notification sent when a suggestion is rejected.

MessageMcpNotification(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(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) -> ClientNotification

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

Available on crate feature unstable_protocol_v2 only.

type Output = ClientNotification

The corresponding v2 draft type.

fn into_v2(self) -> Result<Self::Output>

Converts this value into the corresponding v2 draft type.

impl JsonSchema for ClientNotification

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.