Enum Error 

#[non_exhaustive]
pub enum Error {
    Unauthorized {
        status: u16,
        code: Option<String>,
    },
    Forbidden {
        status: u16,
        code: Option<String>,
    },
    RateLimited {
        retry_after: Option<Duration>,
    },
    Http {
        status: u16,
        code: Option<String>,
        message: Option<String>,
    },
    Decode {
        status: u16,
        message: String,
        snippet: String,
    },
    Transport(Error),
    TooLarge {
        limit: usize,
    },
    Cancelled,
    Config(String),
}

Why a call failed.

No variant holds a token: response bodies are scrubbed (see Error::Decode) and transport errors drop the URL. Snippets also drop personal data (emails, names, phone numbers, addresses).

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.

Unauthorized

The token was refused: HTTP 401, or (from the token endpoint) an invalid_grant, which means the refresh token was revoked or has already been rotated away. The login needs a new token (a refresh, or a new login if refreshing gives this too).

Fields

status: u16

The HTTP status.

code: Option<String>

The API’s error code, if the body had one (invalid_grant, authentication_error, permission_error, …).

Forbidden

HTTP 403: the token is good but may not do this (a scope it lacks, such as an inference-only token on a profile endpoint, or a role it lacks in the organization). Logging in again won’t change it.

Fields

status: u16

The HTTP status (403).

code: Option<String>

The API’s error code, if the body had one (permission_error, …).

RateLimited

HTTP 429.

Fields

retry_after: Option<Duration>

The Retry-After header, if it was there and readable (seconds or an HTTP date).

Http

Any other non-success status.

Fields

status: u16

The HTTP status.

code: Option<String>

The API’s error code, if the body had one.

message: Option<String>

The API’s error message, if the body had one, scrubbed and cut short.

Decode

A success status whose body isn’t the expected JSON.

Fields

status: u16

The HTTP status.

message: String

What didn’t match, with any quoted value in it replaced.

snippet: String

The start of the body, with the values of token-like and personal keys replaced, and any string that looks like a token. That last rule is broad: ids (UUIDs) and other long unbroken strings are replaced too.

Transport(Error)

The request didn’t complete: connect, TLS, a timeout. The error carries no URL.

TooLarge

The response body was larger than the client accepts.

Fields

limit: usize

The limit, in bytes.

Cancelled

Client::refresh_and_store’s task was cancelled before it finished (its runtime shut down).

Config(String)

The client was misconfigured (a bad base URL, a header value).

Implementations

impl Error

pub fn is_unauthorized(&self) -> bool

Whether the login itself is bad (refresh or re-login needed), as opposed to a passing failure. Not true for Error::Forbidden.

pub fn is_forbidden(&self) -> bool

Whether the token was good but not allowed this call (Error::Forbidden).

pub fn is_transient(&self) -> bool

Whether a later retry may succeed: rate limiting, a 5xx, a transport failure.

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.