Struct ApiError 

#[non_exhaustive]
pub struct ApiError {
    pub status: u16,
    pub kind: ApiErrorKind,
    pub error_type: Option<String>,
    pub message: String,
    pub body: Option<Value>,
    pub request_id: Option<String>,
    pub retry_after: Option<Duration>,
}

A non-success response from the API.

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

The HTTP status code.

kind: ApiErrorKind

The category of the status.

error_type: Option<String>

The server’s detail.error_type, for example authentication_error.

message: String

A human-readable description taken from the response body.

body: Option<Value>

The response body, when it was JSON.

request_id: Option<String>

The x-typesafe-request-id response header.

retry_after: Option<Duration>

How long the server asked to wait, from retry-after-ms or Retry-After.

Implementations

impl ApiError

pub fn new(status: u16, message: impl Into<String>) -> Self

An error with status and message, for example to script a failure in a fake.

use std::time::Duration;
use typesafe_client::{ApiError, ApiErrorKind};

let error = ApiError::new(429, "Too many requests").with_retry_after(Duration::from_secs(1));
assert_eq!(error.kind, ApiErrorKind::RateLimited);

pub fn with_error_type(self, error_type: impl Into<String>) -> Self

Sets the server’s error type, such as authentication_error.

pub fn with_request_id(self, request_id: impl Into<String>) -> Self

Sets the request id.

pub fn with_retry_after(self, retry_after: Duration) -> Self

Sets how long the server asked to wait.

pub fn from_response( status: u16, body: &[u8], request_id: Option<String>, retry_after: Option<Duration>, ) -> Self

Builds an error from a raw HTTP response, for transports other than the built-in client. Reads {"detail": {"error_type", "message"}}, {"detail": "..."} and validation lists ({"detail": [{"loc", "msg", "type"}]}).

pub fn field_errors(&self) -> Vec<FieldError>

The fields a validation (422) response rejected. Empty for other errors.

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(error: ApiError) -> Self

Converts to this type from the input type.

impl PartialEq for ApiError

fn eq(&self, other: &ApiError) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ApiError