Struct jsonrpsee_types::params::Params

source ·
pub struct Params<'a>(/* private fields */);
Expand description

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§

source§

impl<'a> Params<'a>

source

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

Create params

source

pub fn is_object(&self) -> bool

Returns true if the contained JSON is an object

source

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.

source

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.

source

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.

source

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.

source

pub fn len_bytes(&self) -> usize

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

source

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

Return the underlying JSON string as a &str.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Params<'a>

§

impl<'a> RefUnwindSafe for Params<'a>

§

impl<'a> Send for Params<'a>

§

impl<'a> Sync for Params<'a>

§

impl<'a> Unpin for Params<'a>

§

impl<'a> UnwindSafe for Params<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.