Struct ApiError 

pub struct ApiError {
    pub status: u16,
    pub kind: ApiErrorKind,
    pub message: String,
    pub body: Option<Value>,
    pub headers: HeaderMap,
    pub request_id: Option<String>,
    pub endpoint: String,
    pub retry_after: Option<Duration>,
}

A request failed because the HTTP response carried an error status.

The Display format is "<METHOD> <URL>: <status> <message> (request_id=<id>)", with the request-ID suffix only when present.

Fields

status: u16

HTTP response status code.

kind: ApiErrorKind

The status-derived error kind.

message: String

The extracted or synthesized message (never the raw body over 200 chars).

body: Option<Value>

The server’s JSON error body when parseable, the raw text otherwise, and None when the body was empty.

headers: HeaderMap

Response headers (the API key is never present in responses).

request_id: Option<String>

x-typesafe-request-id response header value, when present.

endpoint: String

"<METHOD> <URL>" of the request, without query parameters.

retry_after: Option<Duration>

Parsed retry-after-ms / Retry-After delay, when present.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ApiError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for ApiError

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

fn from(error: ApiError) -> Self

Converts to this type from the input type.