Struct jsonrpsee_types::params::Params

pub struct Params<'a>(/* private fields */);

Parameters sent with an incoming JSON-RPC request.

The data containing the params is a Cow<&str> and can either be a borrowed &str of JSON from an incoming super::request::Request (which in turn borrows it from the input buffer that is shared between requests); or, it can be an owned String.

Implementations

impl<'a> Params<'a>

pub fn new(raw: Option<&'a str>) -> Self

Create params

pub fn is_object(&self) -> bool

Returns true if the contained JSON is an object

pub fn sequence(&self) -> ParamsSequence<'_>

Obtain a sequence parser, ParamsSequence.

This allows sequential parsing of the incoming params, using an Iterator-style API and is useful when the RPC request has optional parameters at the tail that may or may not be present.

pub fn parse<T>(&'a self) -> Result<T, ErrorObjectOwned>

where T: Deserialize<'a>,

Attempt to parse all parameters as an array or map into type T.

pub fn one<T>(&'a self) -> Result<T, ErrorObjectOwned>

where T: Deserialize<'a>,

Attempt to parse parameters as an array of a single value of type T, and returns that value.

pub fn into_owned(self) -> Params<'static>

Convert Params<'a> to Params<'static> so that it can be moved across threads.

This will cause an allocation if the params internally are using a borrowed JSON slice.

pub fn len_bytes(&self) -> usize

Return the length of underlying JSON string in number of bytes.

pub fn as_str(&self) -> Option<&str>

Return the underlying JSON string as a &str.

Trait Implementations

impl<'a> Clone for Params<'a>

fn clone(&self) -> Params<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Params<'a>

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

Formats the value using the given formatter.