Struct json_rpc_types::Response

pub struct Response<R, E, EM = StrBuf<31>> {
    pub jsonrpc: Version,
    pub payload: Result<R, Error<E, EM>>,
    pub id: Option<Id>,
}

Response representation.

When omitting id, it shall be serialized as null and means you’re unable to identify id of Request. Note that JSON-RPCv2 specifies that id must be always present, therefore you’re encouraged to treat missing id as error, unless response is error itself, in which case it might be indication that server treats request as invalid (e.g. unable to parse request’s id).

jsonrpc may be omitted during deserialization and defaults to v2.

Type parameters:

• R - Type of payload for successful response
• E - Type of optional data for Error.
• EM - Type of E::M, which is used for message field of error.

Fields

jsonrpc: Version

A String specifying the version of the JSON-RPC protocol.

payload: Result<R, Error<E, EM>>

Content of response, depending on whether it is success or failure.

id: Option<Id>

An identifier established by the Client.

If not present, it is sent in response to invalid request (e.g. unable to recognize id).

Must be present always, so None is serialized as null

Implementations

impl<R, E, EM> Response<R, E, EM>

pub const fn result(jsonrpc: Version, result: R, id: Option<Id>) -> Self

Creates successful response.

pub const fn error( jsonrpc: Version, error: Error<E, EM>, id: Option<Id> ) -> Self

Creates error response.

Trait Implementations

impl<R: Clone, E: Clone, EM: Clone> Clone for Response<R, E, EM>

fn clone(&self) -> Response<R, E, EM>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug, E: Debug, EM: Debug> Debug for Response<R, E, EM>

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

Formats the value using the given formatter.

impl<'de, R: Deserialize<'de>, E: Deserialize<'de>, EM: Deserialize<'de>> Deserialize<'de> for Response<R, E, EM>

fn deserialize<D: Deserializer<'de>>(der: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl<R: PartialEq, E: PartialEq, EM: PartialEq> PartialEq<Response<R, E, EM>> for Response<R, E, EM>

fn eq(&self, other: &Response<R, E, EM>) -> bool

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<R: Serialize, E: Serialize, EM: Serialize> Serialize for Response<R, E, EM>

fn serialize<S: Serializer>(&self, ser: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl<R, E, EM> StructuralPartialEq for Response<R, E, EM>