Struct PingRequest

pub struct PingRequest {
    pub params: Option<PingRequestParams>,
    /* private fields */
}

A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.

JSON schema

{
 "description": "A ping, issued by either the server or the client, to check that the other party is still alive. The receiver must promptly respond, or else may be disconnected.",
 "type": "object",
 "required": [
   "method"
 ],
 "properties": {
   "method": {
     "type": "string",
     "const": "ping"
   },
   "params": {
     "type": "object",
     "properties": {
       "_meta": {
         "type": "object",
         "properties": {
           "progressToken": {
             "description": "If specified, the caller is requesting out-of-band progress notifications for this request (as represented by notifications/progress). The value of this parameter is an opaque token that will be attached to any subsequent notifications. The receiver is not obligated to provide these notifications.",
             "$ref": "#/definitions/ProgressToken"
           }
         }
       }
     },
     "additionalProperties": {}
   }
 }
}

Fields

params: Option<PingRequestParams>

Implementations

impl PingRequest

pub fn new(params: Option<PingRequestParams>) -> Self

pub fn method(&self) -> &String

pub fn method_name() -> String

Trait Implementations

impl Clone for PingRequest

fn clone(&self) -> PingRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PingRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PingRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<PingRequest> for ClientRequest

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl From<PingRequest> for MessageFromClient

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl From<PingRequest> for MessageFromServer

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl From<PingRequest> for RequestFromClient

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl From<PingRequest> for RequestFromServer

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl From<PingRequest> for ServerRequest

fn from(value: PingRequest) -> Self

Converts to this type from the input type.

impl FromMessage<PingRequest> for ClientMessage

fn from_message( message: PingRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

impl FromMessage<PingRequest> for ServerMessage

fn from_message( message: PingRequest, request_id: Option<RequestId>, ) -> Result<Self, RpcError>

impl Serialize for PingRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToMessage<ClientMessage> for PingRequest

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

impl ToMessage<ServerMessage> for PingRequest

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

impl TryFrom<RequestFromClient> for PingRequest

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from(value: RequestFromClient) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<RequestFromServer> for PingRequest

type Error = RpcError

The type returned in the event of a conversion error.

fn try_from(value: RequestFromServer) -> Result<Self, Self::Error>

Performs the conversion.