Struct ApiError 

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

A single unsuccessful HTTP response, with everything a caller needs to react: status, parsed error envelope, request id for support tickets, and the retry delay the server asked for.

Fields

status: u16

HTTP status code (e.g. 429, 529).

code: Option<String>

Machine-readable code from the error envelope (rate_limited, …).

message: Option<String>

Human-readable message from the error envelope, if any.

body: Option<Value>

The parsed JSON error body, when the body was valid JSON.

request_id: Option<String>

The x-typesafe-request-id response header, for support requests.

retry_after: Option<Duration>

Delay the server asked the client to wait via retry-after-ms / Retry-After, if sent.

endpoint: Option<String>

METHOD path of the failed request, e.g. POST /v1/systemone.

Implementations

impl ApiError

pub fn kind(&self) -> ApiErrorKind

Classify this error by HTTP status. See ApiErrorKind.

pub fn is_rate_limit(&self) -> bool

True when this is 429 Too Many Requests.

pub fn is_overloaded(&self) -> bool

True when this is 529 Overloaded (the openkind/TypeSafe overload status).

pub fn is_retryable_later(&self) -> bool

True for 429 and 529 — the statuses that mean “retry later”.

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

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

Converts to this type from the input type.