Struct ApiError 

pub struct ApiError {
    pub status: u16,
    pub body: Option<Value>,
    pub raw_body: String,
    pub request_id: Option<String>,
    pub message: String,
    pub endpoint: String,
    /* private fields */
}

An unsuccessful HTTP response from the API.

Fields

status: u16

HTTP response status code.

body: Option<Value>

Parsed JSON, response text, or None for an empty body.

raw_body: String

Response body as raw bytes.

request_id: Option<String>

Request ID from x-typesafe-request-id, or None when absent.

message: String

Human-readable error message extracted from the response.

endpoint: String

The request method and URL.

Implementations

impl ApiError

pub fn is_bad_request(&self) -> bool

Returns true when status is 400.

pub fn is_authentication(&self) -> bool

Returns true when status is 401.

pub fn is_permission_denied(&self) -> bool

Returns true when status is 403.

pub fn is_not_found(&self) -> bool

Returns true when status is 404.

pub fn is_unprocessable_entity(&self) -> bool

Returns true when status is 422.

pub fn is_rate_limit(&self) -> bool

Returns true when status is 429.

pub fn is_server_error(&self) -> bool

Returns true when status is 5xx.

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

Returns the server’s requested retry delay from response headers, or None when absent or invalid.

Trait Implementations

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, __formatter: &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.