Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub message: String,
    pub kind: ErrorKind,
    pub code: Option<String>,
    pub status: u16,
    pub request_id: Option<String>,
    pub details: Option<Value>,
    pub method: String,
    pub path: String,
    pub retry_after: Option<Duration>,
}

An error returned by the API as a non-2xx HTTP response.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

message: String

A human-readable description, normalized from the API’s error body.

kind: ErrorKind

The classification derived from ApiError::status.

code: Option<String>

A machine-readable error code returned by the API, when present.

status: u16

The HTTP response status code.

request_id: Option<String>

A server request id, read from the response headers. Useful for support.

details: Option<Value>

The raw parsed error body, for advanced inspection.

method: String

The HTTP method of the failing request.

path: String

The path of the failing request.

retry_after: Option<Duration>

The server-requested cooldown parsed from the Retry-After header on a 429 response.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

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.