Struct ProgressNotification

pub struct ProgressNotification {
    pub params: ProgressNotificationParams,
    /* private fields */
}

An out-of-band notification used to inform the receiver of a progress update for a long-running request.

JSON schema

{
 "description": "An out-of-band notification used to inform the receiver of a progress update for a long-running request.",
 "type": "object",
 "required": [
   "method",
   "params"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "notifications/progress"
   },
   "params": {
     "type": "object",
     "required": [
       "progress",
       "progressToken"
     ],
     "properties": {
       "message": {
         "description": "An optional message describing the current progress.",
         "type": "string"
       },
       "progress": {
         "description": "The progress thus far. This should increase every time progress is made, even if the total is unknown.",
         "type": "number"
       },
       "progressToken": {
         "description": "The progress token which was given in the initial request, used to associate this notification with the request that is proceeding.",
         "$ref": "#/definitions/ProgressToken"
       },
       "total": {
         "description": "Total number of items to process (or total progress required), if known.",
         "type": "number"
       }
     }
   }
 }
}

Fields

params: ProgressNotificationParams

Implementations

impl ProgressNotification

pub fn new(params: ProgressNotificationParams) -> ProgressNotification

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for ProgressNotification

fn clone(&self) -> ProgressNotification

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressNotification

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressNotification

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProgressNotification> for ClientJsonrpcNotification

fn from(value: ProgressNotification) -> ClientJsonrpcNotification

Converts to this type from the input type.

impl From<ProgressNotification> for ClientNotification

fn from(value: ProgressNotification) -> ClientNotification

Converts to this type from the input type.

impl From<ProgressNotification> for MessageFromClient

fn from(value: ProgressNotification) -> MessageFromClient

Converts to this type from the input type.

impl From<ProgressNotification> for MessageFromServer

fn from(value: ProgressNotification) -> MessageFromServer

Converts to this type from the input type.

impl From<ProgressNotification> for NotificationFromClient

fn from(value: ProgressNotification) -> NotificationFromClient

Converts to this type from the input type.

impl From<ProgressNotification> for NotificationFromServer

fn from(value: ProgressNotification) -> NotificationFromServer

Converts to this type from the input type.

impl From<ProgressNotification> for ServerJsonrpcNotification

fn from(value: ProgressNotification) -> ServerJsonrpcNotification

Converts to this type from the input type.

impl From<ProgressNotification> for ServerNotification

fn from(value: ProgressNotification) -> ServerNotification

Converts to this type from the input type.

impl FromMessage<ProgressNotification> for ClientMessage

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

impl FromMessage<ProgressNotification> for ServerMessage

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

impl Serialize for ProgressNotification

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 ProgressNotification

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

impl ToMessage<ServerMessage> for ProgressNotification

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

impl TryFrom<NotificationFromClient> for ProgressNotification

type Error = RpcError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<NotificationFromServer> for ProgressNotification

type Error = RpcError

The type returned in the event of a conversion error.

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

Performs the conversion.