Struct jsonrpsee_core::server::MethodResponse

pub struct MethodResponse { /* private fields */ }

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

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 response is a subscription response.

pub fn is_method_call(&self) -> bool

Returns whether the response is a method response.

pub fn is_batch(&self) -> bool

Returns whether the response is a batch response.

pub fn into_result(self) -> String

Consume the method response and extract the serialized response.

pub fn to_result(&self) -> String

Extract the serialized response as a String.

pub fn into_parts(self) -> (String, Option<MethodResponseNotifyTx>)

Consume the method response and extract the parts.

pub fn as_error_code(&self) -> Option<i32>

Get the error code

Returns Some(error code) if the call failed.

pub fn as_result(&self) -> &str

Get a reference to the serialized response.

pub fn from_batch(batch: BatchResponse) -> Self

Create a method response from BatchResponse.

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<'_>, rp: 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.

pub fn extensions(&self) -> &Extensions

Returns a reference to the associated extensions.

pub fn extensions_mut(&mut self) -> &mut Extensions

Returns a reference to the associated extensions.

pub fn with_extensions(self, extensions: Extensions) -> Self

Consumes the method response and returns a new one with the given extensions.

Trait Implementations

impl Debug for MethodResponse

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

Formats the value using the given formatter.