Enum Error 

#[non_exhaustive]
pub enum Error {
    Auth {
        response: Option<ErrorBody>,
    },
    NotFound {
        response: Option<ErrorBody>,
    },
    Validation {
        message: String,
        response: Option<ErrorBody>,
    },
    RateLimit {
        retry_after: u32,
        limit_type: Option<String>,
        response: Option<ErrorBody>,
    },
    Timeout {
        timeout: Duration,
    },
    Api {
        status: u16,
        message: String,
        response: Option<ErrorBody>,
    },
    Transport(Error),
    Decode(Error),
    Build(String),
}

The error type returned by all fallible SDK calls.

Use Error::is_retryable in custom retry policies and Error::status for programmatic dispatch by HTTP status code.

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

HTTP 401 — the API key was missing, malformed, or rejected.

Fields

response: Option<ErrorBody>

The parsed error body, when one was returned.

NotFound

HTTP 404 — the requested resource does not exist.

Fields

response: Option<ErrorBody>

The parsed error body, when one was returned.

Validation

HTTP 400 — the request was syntactically valid but the server rejected its parameters. The message is the SDK’s best guess at a human-readable reason; the SDK walks envelope keys (detail / message / error) first, then sorted-key iteration over the remaining keys, preferring array values over strings.

Fields

message: String

Human-readable validation message.

response: Option<ErrorBody>

The parsed error body, when one was returned.

RateLimit

HTTP 429 — the caller exceeded a rate limit.

retry_after is populated from the Retry-After header when present (in seconds, capped at 10s by the retry loop). limit_type is populated from X-RateLimit-Type when the server sets it (e.g. "minute", "hour", "day").

Fields

retry_after: u32

Seconds to wait before retrying, as suggested by the server.

limit_type: Option<String>

The rate-limit bucket the server reported, when present.

response: Option<ErrorBody>

The parsed error body, when one was returned.

Timeout

A request exceeded its configured timeout. No HTTP status was received.

Fields

timeout: Duration

The timeout duration that elapsed.

Api

Any other non-2xx HTTP response.

Fields

status: u16

HTTP status code.

message: String

Human-readable message.

response: Option<ErrorBody>

The parsed error body, when one was returned.

Transport(Error)

An HTTP transport-level failure (DNS, connection refused, TLS, etc.). Send-safe reqwest::Error is preserved for Error::source traversal.

Decode(Error)

A response body failed JSON decoding.

Build(String)

The SDK failed to build a request (URL parse, bad input, etc.). Strictly internal — callers should not see this in practice.

Implementations

impl Error

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

Returns the HTTP status code for variants that carry one.

pub fn is_retryable(&self) -> bool

Returns true if this error is one the SDK’s retry loop will recover from.

Retryable:

• RateLimit (429)
• Timeout (transport-level deadline)
• Api { status: 5xx } (server-side faults)
• Api { status: 408 } (request timeout reported by server)
• Transport (DNS/TCP/TLS-level failures)

Not retryable:

• Auth / NotFound / Validation (client-side; retry won’t change the answer)
• Api { status: other 4xx }
• Decode / Build (programmer/server error)

pub fn response(&self) -> Option<&ErrorBody>

Returns the parsed error body when one was returned by the server.

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.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.