Enum Error 

#[non_exhaustive]
pub enum Error {
    Api(Box<ApiError>),
    Configuration(String),
    Authentication(String),
    Validation(String),
    NotFound(String),
    Operation {
        kind: ErrorKind,
        code: String,
        message: String,
    },
    Timeout {
        method: String,
        path: String,
        elapsed: Duration,
    },
    Network {
        method: String,
        path: String,
        source: Error,
    },
    Decode {
        context: String,
        source: Error,
    },
    Encode {
        source: Error,
    },
}

The error type returned by every fallible SDK call.

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.

Api(Box<ApiError>)

The API responded with a non-2xx status.

Boxed so that Result<T> stays small on the happy path, which every call in the crate pays for.

Configuration(String)

The client was constructed or used with invalid configuration.

Authentication(String)

A token could not be verified (malformed, bad signature, or expired).

Validation(String)

A client-side precondition failed before the request was sent.

NotFound(String)

The SDK resolved that a resource does not exist without the API saying so, e.g. asking for a participant in a room that has no live session.

Operation

A multi-step operation the SDK drives to completion failed, e.g. a batch-call file that the server could not parse.

Carries a machine-readable code but no HTTP status, since the failure is a result rather than a response.

Fields

kind: ErrorKind

How to classify this failure.

code: String

A machine-readable code, e.g. batchcall_parse_failed.

message: String

A human-readable description.

Timeout

The client-side request timeout elapsed.

Fields

method: String

The HTTP method of the request that timed out.

path: String

The path of the request that timed out.

elapsed: Duration

The timeout that elapsed.

Network

The request could not be sent, or the response could not be read.

Fields

method: String

The HTTP method of the failing request.

path: String

The path of the failing request.

source: Error

The underlying transport error.

Decode

A response body could not be deserialized into the expected type.

Fields

context: String

What was being decoded, e.g. GET /v2/rooms.

source: Error

The underlying deserialization error.

Encode

A request body could not be serialized.

Fields

source: Error

The underlying serialization error.

Implementations

impl Error

pub fn kind(&self) -> ErrorKind

The coarse classification of this error.

pub fn as_api(&self) -> Option<&ApiError>

The underlying ApiError, if this error came from an HTTP response.

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

The HTTP status code, if this error came from an HTTP response.

pub fn code(&self) -> Option<&str>

The machine-readable error code, if present.

pub fn request_id(&self) -> Option<&str>

The server request id, if the response carried one.

pub fn retry_after(&self) -> Option<Duration>

The cooldown the server asked for via Retry-After on a 429.

pub fn is_not_found(&self) -> bool

Whether this is a not-found error (HTTP 404 or 402).

pub fn is_authentication(&self) -> bool

Whether this is an authentication error (HTTP 401, or a bad token).

pub fn is_permission(&self) -> bool

Whether this is a permission error (HTTP 403).

pub fn is_validation(&self) -> bool

Whether this is a validation error (HTTP 400, or a client-side check).

pub fn is_rate_limit(&self) -> bool

Whether this is a rate-limit error (HTTP 429).

pub fn is_conflict(&self) -> bool

Whether this is a conflict error (HTTP 409).

pub fn is_timeout(&self) -> bool

Whether this is a client-side timeout.

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.