Struct SubscriptionError

pub struct SubscriptionError(/* private fields */);

Error returned when a subscription fails where the error is returned as special error notification with the following format:

{"jsonrpc":"2.0", "method":"subscription_error", "params": {"subscription": "sub_id", "error": <error message from this type>}}

It’s recommended to use SubscriptionError::from_json to create a new instance of this error if the underlying error is a JSON value. That will ensure that the error is serialized correctly.

SubscriptionError::from will serialize the error as a string, which is not recommended and should only by used in the value of a String type. It’s mainly provided for convenience and to allow for easy conversion any type that implements StdError.

Implementations

impl SubscriptionError

pub fn from_json(json: Box<RawValue>) -> Self

Create a new SubscriptionError from a JSON value.

Trait Implementations

impl Clone for SubscriptionError

fn clone(&self) -> SubscriptionError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionError

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

Formats the value using the given formatter.

impl<T: ToString> From<T> for SubscriptionError

fn from(val: T) -> Self

Converts to this type from the input type.

impl Serialize for SubscriptionError

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

where S: Serializer,

Serialize this value into the given Serde serializer.