jsonrpsee_types::params

Struct ParamsSequence

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

An Iterator-like parser for a sequence of Params.

This will parse the params one at a time, and allows for graceful handling of optional parameters at the tail; other use cases are likely better served by Params::parse. The reason this is not an actual Iterator is that params parsing (often) yields values of different types.

Regards empty array [] as no parameters provided.

Implementations§

source§

impl<'a> ParamsSequence<'a>

source

pub fn next<T>(&mut self) -> Result<T, ErrorObjectOwned>
where T: Deserialize<'a>,

Parse the next parameter to type T

let params = Params::new(Some(r#"[true, 10, "foo"]"#));
let mut seq = params.sequence();

let a: bool = seq.next().unwrap();
let b: i32 = seq.next().unwrap();
let c: &str = seq.next().unwrap();

assert_eq!(a, true);
assert_eq!(b, 10);
assert_eq!(c, "foo");
source

pub fn optional_next<T>(&mut self) -> Result<Option<T>, ErrorObjectOwned>
where T: Deserialize<'a>,

Parse the next optional parameter to type Option<T>.

The result will be None for null, and for missing values in the supplied JSON array.

let params = Params::new(Some(r#"[1, 2, null]"#));
let mut seq = params.sequence();

let params: [Option<u32>; 4] = [
    seq.optional_next().unwrap(),
    seq.optional_next().unwrap(),
    seq.optional_next().unwrap(),
    seq.optional_next().unwrap(),
];

assert_eq!(params, [Some(1), Some(2), None, None]);

Trait Implementations§

source§

impl<'a> Clone for ParamsSequence<'a>

source§

fn clone(&self) -> ParamsSequence<'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 ParamsSequence<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Copy for ParamsSequence<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for ParamsSequence<'a>

§

impl<'a> RefUnwindSafe for ParamsSequence<'a>

§

impl<'a> Send for ParamsSequence<'a>

§

impl<'a> Sync for ParamsSequence<'a>

§

impl<'a> Unpin for ParamsSequence<'a>

§

impl<'a> UnwindSafe for ParamsSequence<'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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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,

source§

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>,

source§

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>,

source§

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.