Enum Error 

pub enum Error {
    Api(Box<ApiError>),
    Connection(Box<dyn Error + Send + Sync>),
    Timeout {
        timeout: Duration,
    },
    ResponseTooLarge {
        limit: usize,
    },
    Decode {
        status: u16,
        body_excerpt: String,
        source: Error,
    },
    InvalidResponse {
        source: ValidationError,
    },
    Config(String),
}

All client failures. Error::Api wraps the unsuccessful-response case; the other variants cover transport, timeout, decoding, response validation, and configuration problems.

Variants

Api(Box<ApiError>)

The server responded with a non-success status. See ApiError.

(Boxed to keep Result<T, Error> small; deref coercion makes the inner ApiError fields directly accessible.)

Connection(Box<dyn Error + Send + Sync>)

The request could not reach, or the response could not be read from, the server.

Timeout

The request exceeded its per-attempt timeout.

Fields

timeout: Duration

The timeout that was in effect for the failed attempt.

ResponseTooLarge

A response body exceeded the client’s fixed memory-safety limit.

Fields

limit: usize

Maximum response-body size accepted by the client.

Decode

A 2xx response body could not be decoded as the expected type.

Fields

status: u16

HTTP status of the undecodable response.

body_excerpt: String

The first 200 chars of the raw body, to aid debugging.

source: Error

The underlying JSON error.

InvalidResponse

A 2xx response decoded but violated the submitted question contract.

Fields

source: ValidationError

The violated request/response invariant. Response content is omitted.

Config(String)

The client was constructed with invalid settings (missing API key, bad base URL, non-positive timeout, …).

Implementations

impl Error

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

HTTP status, when the error originated from a server response.

pub fn retry_after(&self) -> Option<Duration>

The server-requested retry delay, when present.

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

The x-typesafe-request-id of the failed request, when present.

pub fn kind(&self) -> Option<ApiErrorKind>

The error kind classification, when this is an API error.

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<Box<ApiError>> for Error

fn from(source: Box<ApiError>) -> Self

Converts to this type from the input type.