Enum ResponsePayload

pub enum ResponsePayload<Payload = Box<RawValue>, ErrData = Box<RawValue>> {
    Success(Payload),
    Failure(ErrorPayload<ErrData>),
}

A JSON-RPC 2.0 response payload.

This enum covers both the success and error cases of a JSON-RPC 2.0 response. It is used to represent the result and error fields of a response object.

Note

This type does not implement Serialize or Deserialize directly. It is deserialized as part of the Response type.

Variants

Success(Payload)

A successful response payload.

Failure(ErrorPayload<ErrData>)

An error response payload.

Implementations

impl ResponsePayload<&RawValue, &RawValue>

pub fn into_owned(self) -> ResponsePayload

Convert this borrowed response payload into an owned payload by copying the data from the deserializer (if necessary).

impl<Payload, ErrData> ResponsePayload<Payload, ErrData>

pub const fn parse_error() -> Self

Create a new error payload for a parse error.

pub const fn invalid_request() -> Self

Create a new error payload for an invalid request.

pub const fn method_not_found() -> Self

Create a new error payload for a method not found error.

pub const fn invalid_params() -> Self

Create a new error payload for an invalid params error.

pub const fn internal_error() -> Self

Create a new error payload for an internal error.

pub const fn internal_error_message(message: Cow<'static, str>) -> Self

Create a new error payload for an internal error with a custom message.

pub const fn internal_error_with_obj(data: ErrData) -> Self

where ErrData: RpcObject,

Create a new error payload for an internal error with a custom message and additional data.

pub const fn internal_error_with_message_and_obj( message: Cow<'static, str>, data: ErrData, ) -> Self

where ErrData: RpcObject,

Create a new error payload for an internal error with a custom message and additional data.

pub const fn as_success(&self) -> Option<&Payload>

Fallible conversion to the successful payload.

pub const fn as_error(&self) -> Option<&ErrorPayload<ErrData>>

Fallible conversion to the error object.

pub const fn is_success(&self) -> bool

Returns true if the response payload is a success.

pub const fn is_error(&self) -> bool

Returns true if the response payload is an error.

impl<Payload, ErrData> ResponsePayload<Payload, ErrData>

where Payload: RpcObject, ErrData: RpcObject,

pub fn serialize_payload(&self) -> Result<ResponsePayload>

Convert the inner types into a RawValue by serializing them.

impl<'a, Payload, ErrData> ResponsePayload<Payload, ErrData>

where Payload: AsRef<RawValue> + 'a,

pub fn try_success_as<T: Deserialize<'a>>(&'a self) -> Option<Result<T>>

Attempt to deserialize the success payload, borrowing from the payload if necessary.

Returns

• None if the payload is an error
• Some(Ok(T)) if the payload is a success and can be deserialized
• Some(Err(serde_json::Error)) if the payload is a success and can’t be deserialized as T

pub fn deserialize_success<T: DeserializeOwned>( self, ) -> Result<ResponsePayload<T, ErrData>, Self>

Deserialize a Success payload, if possible, transforming this type.

Returns

• Ok(ResponsePayload<T>) if the payload is an error, or if the payload is a success and can be deserialized as T
• Err(self) if the payload is a success and can’t be deserialized

impl<'a, Payload, Data> ResponsePayload<Payload, Data>

where Data: Borrow<RawValue> + 'a,

pub fn try_error_as<T: Deserialize<'a>>(&'a self) -> Option<Result<T>>

Attempt to deserialize the error payload, borrowing from the payload if necessary.

Returns

• None if the payload is a success
• Some(Ok(T)) if the payload is an error and can be deserialized
• Some(Err(serde_json::Error)) if the payload is an error and can’t be deserialized as T

pub fn deserialize_error<T: DeserializeOwned>( self, ) -> Result<ResponsePayload<Payload, T>, Self>

Deserialize an Error payload, if possible, transforming this type.

Returns

• Ok(ResponsePayload<Payload, T>) if the payload is an error, or if the payload is an error and can be deserialized as T.
• Err(self) if the payload is an error and can’t be deserialized.

Trait Implementations

impl<Payload: Clone, ErrData: Clone> Clone for ResponsePayload<Payload, ErrData>

fn clone(&self) -> ResponsePayload<Payload, ErrData>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Payload: Debug, ErrData: Debug> Debug for ResponsePayload<Payload, ErrData>

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

Formats the value using the given formatter.

impl<Payload: PartialEq, ErrData: PartialEq> PartialEq for ResponsePayload<Payload, ErrData>

fn eq(&self, other: &ResponsePayload<Payload, ErrData>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Payload: Eq, ErrData: Eq> Eq for ResponsePayload<Payload, ErrData>

impl<Payload, ErrData> StructuralPartialEq for ResponsePayload<Payload, ErrData>