Enum Error 

#[non_exhaustive]
pub enum Error {
    Config(String),
    InvalidRequest(String),
    Api(ApiError),
    Connection(String),
    Decode(String),
}

Errors returned by this SDK.

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.

Config(String)

The client is misconfigured (e.g. a missing API key or invalid URL).

InvalidRequest(String)

The request failed client-side validation before anything was sent.

Api(ApiError)

The API returned an unsuccessful HTTP response (after any retries).

Connection(String)

The request could not be sent, or the connection failed (after any retries). Includes request timeouts.

Decode(String)

A successful response body could not be decoded.

Implementations

impl Error

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

The HTTP status code, if this is an API error.

pub fn is_authentication(&self) -> bool

Whether the request failed authentication (HTTP 401).

pub fn is_rate_limited(&self) -> bool

Whether the request was rate-limited or the service was overloaded (HTTP 429 or 529).

pub fn is_validation(&self) -> bool

Whether the request body failed server-side validation (HTTP 400 or 422).

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.