Struct jsonrpsee_core::server::helpers::MethodResponse

pub struct MethodResponse {
    pub result: String,
    pub success_or_error: MethodResponseResult,
    pub is_subscription: bool,
}

Available on crate feature server only.

Represents a response to a method call.

NOTE: A subscription is also a method call but it’s possible determine whether a method response is “subscription” or “ordinary method call” by calling MethodResponse::is_subscription

Fields

result: String

Serialized JSON-RPC response,

success_or_error: MethodResponseResult

Indicates whether the call was successful or not.

is_subscription: bool

Indicates whether the call was a subscription response.

Implementations

impl MethodResponse

pub fn is_success(&self) -> bool

Returns whether the call was successful.

pub fn is_error(&self) -> bool

Returns whether the call failed.

pub fn is_subscription(&self) -> bool

Returns whether the call is a subscription.

impl MethodResponse

pub fn subscription_response<T>( id: Id<'_>, result: ResponsePayload<'_, T>, max_response_size: usize ) -> Self

where T: Serialize + Clone,

This is similar to MethodResponse::response but sets a flag to indicate that response is a subscription.

pub fn response<T>( id: Id<'_>, result: ResponsePayload<'_, T>, max_response_size: usize ) -> Self

where T: Serialize + Clone,

Create a new method response.

If the serialization of result exceeds max_response_size then the response is changed to an JSON-RPC error object.

pub fn subscription_error<'a>( id: Id<'_>, err: impl Into<ErrorObject<'a>> ) -> Self

This is similar to MethodResponse::error but sets a flag to indicate that error is a subscription.

pub fn error<'a>(id: Id<'_>, err: impl Into<ErrorObject<'a>>) -> Self

Create a MethodResponse from a JSON-RPC error.

Trait Implementations

impl Clone for MethodResponse

fn clone(&self) -> MethodResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MethodResponse

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

Formats the value using the given formatter.