Trait jsonrpsee_core::traits::ToRpcParams

pub trait ToRpcParams {
    // Required method
    fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>;
}

Marker trait for types that can be serialized as JSON compatible strings.

This trait ensures the correctness of the RPC parameters.

Note

Please consider using the crate::params::ArrayParams and crate::params::ObjectParams than implementing this trait.

Examples

Implementation for hard-coded strings

use jsonrpsee_core::traits::ToRpcParams;
use serde_json::value::RawValue;

struct ManualParam;

impl ToRpcParams for ManualParam {
    fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, serde_json::Error> {
        // Manually define a valid JSONRPC parameter.
        RawValue::from_string("[1, \"2\", 3]".to_string()).map(Some)
    }
}

Implementation for JSON serializable structures

use jsonrpsee_core::traits::ToRpcParams;
use serde_json::value::RawValue;
use serde::Serialize;

#[derive(Serialize)]
struct SerParam {
    param_1: u8,
    param_2: String,
};

impl ToRpcParams for SerParam {
    fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, serde_json::Error> {
        let s = String::from_utf8(serde_json::to_vec(&self)?).expect("Valid UTF8 format");
        RawValue::from_string(s).map(Some)
    }
}

Required Methods

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

Consume and serialize the type as a JSON raw value.

Implementations on Foreign Types

impl<P, const N: usize> ToRpcParams for [P; N]

where [P; N]: Serialize,

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<P: Serialize> ToRpcParams for &[P]

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<P: Serialize> ToRpcParams for Vec<P>

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize> ToRpcParams for (T0,)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize> ToRpcParams for (T0, T1)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize> ToRpcParams for (T0, T1, T2)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize> ToRpcParams for (T0, T1, T2, T3)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize> ToRpcParams for (T0, T1, T2, T3, T4)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize, T11: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize, T11: Serialize, T12: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize, T11: Serialize, T12: Serialize, T13: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize, T11: Serialize, T12: Serialize, T13: Serialize, T14: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

impl<T0: Serialize, T1: Serialize, T2: Serialize, T3: Serialize, T4: Serialize, T5: Serialize, T6: Serialize, T7: Serialize, T8: Serialize, T9: Serialize, T10: Serialize, T11: Serialize, T12: Serialize, T13: Serialize, T14: Serialize, T15: Serialize> ToRpcParams for (T0, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)

fn to_rpc_params(self) -> Result<Option<Box<RawValue>>, Error>

Implementors

impl ToRpcParams for ArrayParams

impl ToRpcParams for ObjectParams