Enum Error 

#[non_exhaustive]
pub enum Error {
    Transport(Error),
    Decode(String),
    InvalidRequest(String),
    Api {
        status: u16,
        info: ErrorInfo,
    },
}

The single error type surfaced by this crate.

#[non_exhaustive] so new variants can be added without a breaking change.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Transport(Error)

An HTTP transport failure from reqwest (connection, timeout, TLS, …).

Decode(String)

The response body could not be decoded into the expected type.

InvalidRequest(String)

A request was rejected by client-side validation before being sent (e.g. a distinct/multiple reaction delete missing its name).

Api

A non-2xx response carrying the Ably error envelope.

Fields

status: u16

The HTTP status code of the response.

info: ErrorInfo

The parsed Ably error envelope.

Implementations

impl Error

pub fn status(&self) -> Option<u16>

The HTTP status code associated with this error, if any.

pub fn info(&self) -> Option<&ErrorInfo>

The parsed Ably error envelope, if this is an API error.

pub fn is_retryable(&self) -> bool

Whether retrying the request that produced this error may succeed.

Transport timeouts/connect failures, HTTP 429, and 5xx are retryable; decode failures and other API errors are not. The dispatch layer only actually retries requests that are also idempotency-safe (ADR-0006).

pub fn is_not_found(&self) -> bool

Ably code 40400: the message was not found.

pub fn is_rejected_by_rule(&self) -> bool

Ably code 42211: the operation was rejected by a room rule.

pub fn is_rejected_by_moderation(&self) -> bool

Ably code 42213: the operation was rejected by moderation.

pub fn is_token_error(&self) -> bool

Whether this is an Ably token error (HTTP 401, code in [40140, 40150)) that a configured TokenProvider should renew on (spec RSA4b).

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.