Struct CancelledNotification

pub struct CancelledNotification {
    pub params: CancelledNotificationParams,
    /* private fields */
}

This notification can be sent by either side to indicate that it is cancelling a previously-issued request. The request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished. This notification indicates that the result will be unused, so any associated processing SHOULD cease. A client MUST NOT attempt to cancel its initialize request.

JSON schema

{
 "description": "This notification can be sent by either side to indicate that it is cancelling a previously-issued request.\n\nThe request SHOULD still be in-flight, but due to communication latency, it is always possible that this notification MAY arrive after the request has already finished.\n\nThis notification indicates that the result will be unused, so any associated processing SHOULD cease.\n\nA client MUST NOT attempt to cancel its initialize request.",
 "type": "object",
 "required": [
   "method",
   "params"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "notifications/cancelled"
   },
   "params": {
     "type": "object",
     "required": [
       "requestId"
     ],
     "properties": {
       "reason": {
         "description": "An optional string describing the reason for the cancellation. This MAY be logged or presented to the user.",
         "type": "string"
       },
       "requestId": {
         "description": "The ID of the request to cancel.\n\nThis MUST correspond to the ID of a request previously issued in the same direction.",
         "$ref": "#/definitions/RequestId"
       }
     }
   }
 }
}

Fields

params: CancelledNotificationParams

Implementations

impl CancelledNotification

pub fn new(params: CancelledNotificationParams) -> CancelledNotification

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for CancelledNotification

fn clone(&self) -> CancelledNotification

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelledNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CancelledNotification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CancelledNotification> for ClientJsonrpcNotification

fn from(value: CancelledNotification) -> ClientJsonrpcNotification

Converts to this type from the input type.

impl From<CancelledNotification> for ClientNotification

fn from(value: CancelledNotification) -> ClientNotification

Converts to this type from the input type.

impl From<CancelledNotification> for MessageFromClient

fn from(value: CancelledNotification) -> MessageFromClient

Converts to this type from the input type.

impl From<CancelledNotification> for MessageFromServer

fn from(value: CancelledNotification) -> MessageFromServer

Converts to this type from the input type.

impl From<CancelledNotification> for NotificationFromClient

fn from(value: CancelledNotification) -> NotificationFromClient

Converts to this type from the input type.

impl From<CancelledNotification> for NotificationFromServer

fn from(value: CancelledNotification) -> NotificationFromServer

Converts to this type from the input type.

impl From<CancelledNotification> for ServerJsonrpcNotification

fn from(value: CancelledNotification) -> ServerJsonrpcNotification

Converts to this type from the input type.

impl From<CancelledNotification> for ServerNotification

fn from(value: CancelledNotification) -> ServerNotification

Converts to this type from the input type.

impl FromMessage<CancelledNotification> for ClientMessage

fn from_message( message: CancelledNotification, request_id: Option<RequestId>, ) -> Result<ClientMessage, RpcError>

impl FromMessage<CancelledNotification> for ServerMessage

fn from_message( message: CancelledNotification, request_id: Option<RequestId>, ) -> Result<ServerMessage, RpcError>

impl Serialize for CancelledNotification

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 ToMessage<ClientMessage> for CancelledNotification

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ClientMessage, RpcError>

impl ToMessage<ServerMessage> for CancelledNotification

fn to_message( self, request_id: Option<RequestId>, ) -> Result<ServerMessage, RpcError>

impl TryFrom<NotificationFromClient> for CancelledNotification

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: NotificationFromClient, ) -> Result<CancelledNotification, <CancelledNotification as TryFrom<NotificationFromClient>>::Error>

Performs the conversion.

impl TryFrom<NotificationFromServer> for CancelledNotification

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from( value: NotificationFromServer, ) -> Result<CancelledNotification, <CancelledNotification as TryFrom<NotificationFromServer>>::Error>

Performs the conversion.