Enum Error 

#[non_exhaustive]
pub enum Error {
    Api {
        status: StatusCode,
        message: String,
        request_id: Option<String>,
    },
    RateLimited {
        retry_after: Option<Duration>,
    },
    Auth(String),
    Transport(Error),
    Decode {
        endpoint: String,
        source: Error,
    },
    Config(String),
}

All errors returned by this crate.

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

The API returned a non-success status code.

Fields

status: StatusCode

HTTP status returned by the API.

message: String

Human-readable message extracted from the error body.

request_id: Option<String>

Request id echoed by the API, when present (useful in support threads).

RateLimited

The API returned 429 and retries were exhausted.

Fields

retry_after: Option<Duration>

Server-suggested wait before retrying, from the Retry-After header.

Auth(String)

Authentication problems: missing credentials, failed token refresh, etc.

Transport(Error)

Network / TLS / protocol-level failures.

Decode

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

Fields

endpoint: String

The API path whose response failed to decode.

source: Error

The underlying deserialization error.

Config(String)

Invalid client configuration.

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.