Enum near_jsonrpc_primitives::message::Message

pub enum Message {
    Request(Request),
    Response(Response),
    Notification(Notification),
    Batch(Vec<Message>),
    UnmatchedSub(Value),
}

One message of the JSON RPC protocol.

One message, directly mapped from the structures of the protocol. See the specification for more details.

Since the protocol allows one endpoint to be both client and server at the same time, the message can decode and encode both directions of the protocol.

The Batch variant is supposed to be created directly, without a constructor.

The UnmatchedSub variant is used when a request is an array and some of the subrequests aren’t recognized as valid json rpc 2.0 messages. This is never returned as a top-level element, it is returned as Err(Broken::Unmatched).

Variants

Request(Request)

An RPC request.

Tuple Fields of Request

0: Request

Response(Response)

A response to a Request.

Tuple Fields of Response

0: Response

Notification(Notification)

A notification.

Tuple Fields of Notification

0: Notification

Batch(Vec<Message>)

A batch of more requests or responses.

The protocol allows bundling multiple requests, notifications or responses to a single message.

This variant has no direct constructor and is expected to be constructed manually.

Tuple Fields of Batch

0: Vec<Message>

UnmatchedSub(Value)

An unmatched sub entry in a Batch.

When there’s a Batch and an element doesn’t comform to the JSONRPC 2.0 format, that one is represented by this. This is never produced as a top-level value when parsing, the Err(Broken::Unmatched) is used instead. It is not possible to serialize.

Tuple Fields of UnmatchedSub

0: Value

Implementations

impl Message

pub fn request(method: String, params: Option<Value>) -> Self

A constructor for a request.

The ID is auto-generated.

pub fn error(error: RpcError) -> Self

Create a top-level error (without an ID).

pub fn notification(method: String, params: Option<Value>) -> Self

A constructor for a notification.

pub fn response(id: Value, result: Result<Value, RpcError>) -> Self

A constructor for a response.

pub fn id(&self) -> Value

Returns id or Null if there is no id.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Message

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

Deserialize this value from the given Serde deserializer.

impl Into<String> for Message

fn into(self) -> String

Performs the conversion.

impl Into<Vec<u8, Global>> for Message

fn into(self) -> Vec<u8>

Performs the conversion.

impl PartialEq<Message> for Message

fn eq(&self, other: &Message) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Message) -> bool

This method tests for !=.

impl Serialize for Message

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Message