Struct ApiError 

pub struct ApiError { /* private fields */ }

An unsuccessful HTTP response from the API.

Implementations

impl ApiError

pub fn from_response( status: StatusCode, headers: HeaderMap, body: &[u8], ) -> Self

Build an error from a raw response, deriving its kind and message.

pub fn kind(&self) -> ApiErrorKind

The class of the status code.

pub fn status(&self) -> StatusCode

The HTTP status.

pub fn headers(&self) -> &HeaderMap

The response headers.

pub fn body(&self) -> &ErrorBody

The parsed response body.

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

The request ID from x-typesafe-request-id.

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

The server’s retry delay from retry-after-ms or Retry-After.

Usually present on ApiErrorKind::RateLimit, sometimes on 503.

pub fn message(&self) -> &str

The error message, "<status> <detail>".

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.

impl From<ApiError> for Error

fn from(err: ApiError) -> Self

Converts to this type from the input type.