Struct Request

pub struct Request {
    pub jsonrpc: String,
    pub id: Value,
    pub method: String,
    pub params: Option<Value>,
}

JSON-RPC request

Fields

jsonrpc: String

Protocol header

id: Value

Request ID

method: String

Method name

params: Option<Value>

Optional method arguments

Implementations

impl Request

pub fn try_from_reader<R>(reader: R) -> Result<(usize, Self), Error>

where R: Read,

Read a request from a reader.

Returns the number of consumed bytes and the request.

pub fn try_to_writer<W>(&self, writer: W) -> Result<usize, Error>

where W: Write,

Write a request to a writer and return the number of bytes written.

impl Request

pub fn new<M>(method: M) -> Self

where M: ToString,

Create a new request with the provided method.

Will generate a random ID, if the feature uuid is enabled. Otherwise, set the ID to 0.

pub fn with_id<I>(self, id: I) -> Self

where I: Into<Number>,

Replace the method ID with the provided numeric value

pub fn with_id_string<I>(self, id: I) -> Self

where I: ToString,

Replace the method ID with the provided string

pub fn with_params<P>(self, params: P) -> Result<Self, Error>

where P: Serialize,

Replace the methods arguments with the provided value

pub fn with_params_value(self, params: Value) -> Self

Replace the methods arguments with the parsed value

pub fn prepare(&self) -> (Value, String)

Split the request into its ID and message

pub fn parse(s: &str) -> Result<(Self, &str), Error>

Parse a message into the request, returning the remainder string

pub fn parse_json(json: &str) -> Result<Self, Error>

Parse a request from the provided JSON

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Request

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

Formats the value using the given formatter.

impl From<Request> for Message

fn from(request: Request) -> Self

Converts to this type from the input type.

impl FromStr for Request

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Request

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Message> for Request

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.