Enum ProtocolLevelNotification 

#[non_exhaustive]
pub enum ProtocolLevelNotification {
    CancelRequestNotification(CancelRequestNotification),
}

General protocol-level notifications that all sides are expected to implement.

Notifications whose methods start with ‘$/’ are messages which are protocol implementation dependent and might not be implementable in all clients or agents. For example if the implementation uses a single threaded synchronous programming language then there is little it can do to react to a $/cancel_request notification. If an agent or client receives notifications starting with ‘$/’ it is free to ignore the notification.

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.

CancelRequestNotification(CancelRequestNotification)

Cancels an ongoing request.

This is a notification sent by the side that sent a request to cancel that request.

Upon receiving this notification, the receiver:

1. MAY cancel the corresponding request activity and all nested activities
2. MAY send any pending notifications.
3. MUST send one of these responses for the original request:

• Valid response with appropriate data (partial results or cancellation marker)
• Error response with code -32800 (Cancelled)

See protocol docs: Cancellation

Implementations

impl ProtocolLevelNotification

pub fn method(&self) -> &str

Returns the corresponding method name of the notification.

Trait Implementations

impl Clone for ProtocolLevelNotification

fn clone(&self) -> ProtocolLevelNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtocolLevelNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProtocolLevelNotification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoV2 for ProtocolLevelNotification

Available on crate feature unstable_protocol_v2 only.

type Output = ProtocolLevelNotification

The corresponding v2 draft type.

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

Converts this value into the corresponding v2 draft type.

impl JsonSchema for ProtocolLevelNotification

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 ProtocolLevelNotification

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

where __S: Serializer,

Serialize this value into the given Serde serializer.