Struct alloy_json_rpc::Response

pub struct Response<Payload = Box<RawValue>, ErrData = Box<RawValue>> {
    pub id: Id,
    pub payload: ResponsePayload<Payload, ErrData>,
}

A JSON-RPC 2.0 response object containing a ResponsePayload.

This object is used to represent a JSON-RPC 2.0 response. It may contain either a successful result or an error. The id field is used to match the response to the request that it is responding to, and should be mirrored from the response.

Fields

id: Id

The ID of the request that this response is responding to.

payload: ResponsePayload<Payload, ErrData>

The response payload.

Implementations

impl Response<&RawValue, &RawValue>

pub fn into_owned(self) -> Response

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

impl<Payload, ErrData> Response<Payload, ErrData>

pub const fn parse_error(id: Id) -> Self

Create a new response with a parsed error payload.

pub const fn invalid_request(id: Id) -> Self

Create a new response with an invalid request error payload.

pub const fn method_not_found(id: Id) -> Self

Create a new response with a method not found error payload.

pub const fn invalid_params(id: Id) -> Self

Create a new response with an invalid params error payload.

pub const fn internal_error(id: Id) -> Self

Create a new response with an internal error payload.

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

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

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

where ErrData: RpcObject,

Create a new error response for an internal error with additional data.

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

where ErrData: RpcObject,

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

pub const fn is_success(&self) -> bool

Returns true if the response is a success.

pub const fn is_error(&self) -> bool

Returns true if the response is an error.

impl<Payload, ErrData> Response<Payload, ErrData>

where Payload: RpcObject, ErrData: RpcObject,

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

Serialize the payload of this response.

impl<'a, Payload, ErrData> Response<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.

See ResponsePayload::try_success_as.

pub fn deser_success<T: DeserializeOwned>( self, ) -> Result<Response<T, ErrData>, Self>

Attempt to deserialize the Success payload, transforming this type.

Returns

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

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

where ErrData: 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.

See ResponsePayload::try_error_as.

pub fn deser_err<T: DeserializeOwned>( self, ) -> Result<Response<Payload, T>, Self>

Attempt to deserialize the Error payload, transforming this type.

Returns

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

Trait Implementations

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

fn clone(&self) -> Response<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 Response<Payload, ErrData>

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

Formats the value using the given formatter.

impl<'de, Payload, ErrData> Deserialize<'de> for Response<Payload, ErrData>

where Payload: Deserialize<'de>, ErrData: Deserialize<'de>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Response> for PubSubItem

fn from(response: Response) -> Self

Converts to this type from the input type.

impl<Payload, ErrData> FromIterator<Response<Payload, ErrData>> for ResponsePacket<Payload, ErrData>

fn from_iter<T: IntoIterator<Item = Response<Payload, ErrData>>>( iter: T, ) -> Self

Creates a value from an iterator.

impl<Payload, ErrData> Serialize for Response<Payload, ErrData>

where Payload: Serialize, ErrData: Serialize,

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.