Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: u16,
    pub kind: ApiErrorKind,
    pub message: String,
    pub body: Option<Value>,
    pub headers: HeaderMap,
    pub endpoint: Option<String>,
}

An unsuccessful 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.

status: u16

HTTP status code.

kind: ApiErrorKind

Classification of status.

message: String

Human-readable message extracted from the body.

body: Option<Value>

The JSON error body, the raw text as Value::String when it is not JSON, or None when empty.

headers: HeaderMap

Response headers.

endpoint: Option<String>

"METHOD url" without credentials, query or fragment.

Implementations

impl ApiError

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

The x-typesafe-request-id response header.

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

The wait the server asked for via retry-after-ms or Retry-After.

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.

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.