Struct cuprate_json_rpc::Request

pub struct Request<T> {
    pub jsonrpc: Version,
    pub id: Option<Id>,
    pub body: T,
}

The request object.

The generic T is the body type of the request, i.e. it is the type that holds both the method and params.

Fields

jsonrpc: Version

JSON-RPC protocol version; always 2.0.

id: Option<Id>

An identifier established by the Client.

If it is not included it is assumed to be a notification.

None vs Some(Id::Null)

This field will be completely omitted during serialization if None, however if it is Some(Id::Null), it will be serialized as "id": null.

Note that the JSON-RPC 2.0 specification discourages the use of Id::NUll, so if there is no ID needed, consider using None.

body: T

The method and params fields.

• method: A type that serializes as the name of the method to be invoked.
• params: A structured value that holds the parameter values to be used during the invocation of the method.

As mentioned in the library documentation, there are no method/params fields in Request, they are both merged in this body field which is #[serde(flatten)]ed.

Invariant

Your T must serialize as method and params to comply with the specification.

Implementations

impl<T> Request<T>

pub const fn new(body: T) -> Self

Create a new Self with no Id.

use cuprate_json_rpc::Request;

assert_eq!(Request::new("").id, None);

pub const fn new_with_id(id: Id, body: T) -> Self

Create a new Self with an Id.

use cuprate_json_rpc::{Id, Request};

assert_eq!(Request::new_with_id(Id::Num(0), "").id, Some(Id::Num(0)));

pub const fn is_notification(&self) -> bool

Returns true if the request is notification.

In other words, if id is None, this returns true.

use cuprate_json_rpc::{Id, Request};

assert!(Request::new("").is_notification());
assert!(!Request::new_with_id(Id::Null, "").is_notification());

Trait Implementations

impl<T: Clone> Clone for Request<T>

fn clone(&self) -> Request<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Request<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Request<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Request<T>

where T: Display + Serialize,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Request<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Request<T>

fn cmp(&self, other: &Request<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Request<T>

fn eq(&self, other: &Request<T>) -> 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<T: PartialOrd> PartialOrd for Request<T>

fn partial_cmp(&self, other: &Request<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Serialize for Request<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: Eq> Eq for Request<T>

impl<T> StructuralPartialEq for Request<T>

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.