Enum Error 

#[non_exhaustive]
pub enum Error {
    Auth(Box<ErrorDetails>),
    Plan(Box<ErrorDetails>),
    RateLimit(Box<ErrorDetails>),
    Validation(Box<ErrorDetails>),
    NotFound(Box<ErrorDetails>),
    Conflict(Box<ErrorDetails>),
    Server(Box<ErrorDetails>),
    Api(Box<ErrorDetails>),
    Timeout(String),
    Connection(Error),
    Decode(String),
    Config(String),
}

Every error returned by a Floopy-only resource.

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.

Auth(Box<ErrorDetails>)

HTTP 401, or 403 without a feature field.

Plan(Box<ErrorDetails>)

HTTP 403 with a feature field: the current plan does not include the requested capability (see ErrorDetails::feature).

RateLimit(Box<ErrorDetails>)

HTTP 429 (see ErrorDetails::retry_after_seconds).

Validation(Box<ErrorDetails>)

HTTP 400.

NotFound(Box<ErrorDetails>)

HTTP 404.

Conflict(Box<ErrorDetails>)

HTTP 409.

Server(Box<ErrorDetails>)

HTTP 5xx.

Api(Box<ErrorDetails>)

Any other non-2xx response.

Timeout(String)

The request exceeded its deadline.

Connection(Error)

A network failure talking to the gateway.

Decode(String)

A 2xx response whose body could not be decoded.

Config(String)

Invalid client configuration (e.g. an empty API key).

Implementations

impl Error

pub fn details(&self) -> Option<&ErrorDetails>

The structured detail for gateway-originated errors, if any.

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

The HTTP status code, when the error originated from a response.

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

The X-Request-Id of the failed request, when present.

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

The plan capability the request needed, for Error::Plan.

pub fn retry_after_seconds(&self) -> Option<u64>

The Retry-After hint in seconds, for Error::RateLimit.

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.