Struct ApiError 

pub struct ApiError {
    pub status: StatusCode,
    pub body: Value,
    pub headers: HeaderMap,
    pub endpoint: Option<String>,
}

An unsuccessful HTTP response with its body and request metadata.

Display and Debug omit the body and arbitrary headers. Inspect Self::message or body explicitly when server details are appropriate to expose.

Fields

status: StatusCode

HTTP response status.

body: Value

JSON error data, response text as a string, or null for an empty body.

headers: HeaderMap

The original response headers.

endpoint: Option<String>

Request method and URL, without URL credentials, query, or fragment.

Implementations

impl ApiError

pub fn new( status: StatusCode, body: Value, headers: HeaderMap, endpoint: Option<String>, ) -> Self

Construct an API error and sanitize the optional endpoint.

pub fn kind(&self) -> ApiErrorKind

Classify the error by its HTTP status.

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

The x-typesafe-request-id response header, if valid UTF-8.

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

Server-requested retry delay, preferring retry-after-ms.

pub fn message(&self) -> String

Extract the server’s error message, including FastAPI validation details.

This can contain response data; it is deliberately omitted from automatic error formatting. Unstructured fallback bodies are limited to 200 characters.

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.