Struct ApiError 

pub struct ApiError<E> {
    pub status: u16,
    pub headers: HeaderMap,
    pub body: String,
    pub raw_body: Vec<u8>,
    pub typed: Option<E>,
    pub parse_error: Option<String>,
}

Envelope returned for any HTTP response that we received but couldn’t (or didn’t) treat as a successful typed result.

Includes both non-2xx responses and 2xx responses whose body failed to deserialize into the expected success type. status, headers, and raw_body preserve what the server actually sent, while body is a convenient lossy UTF-8 rendering. typed carries the parsed per-operation error variant when the body matched a declared schema. Formatting the error limits only the displayed body preview; the public fields retain the complete response and parsing details.

Fields

status: u16

headers: HeaderMap

body: String

raw_body: Vec<u8>

Exact response bytes before lossy UTF-8 conversion.

typed: Option<E>

parse_error: Option<String>

Implementations

impl<E> ApiError<E>

pub fn is_client_error(&self) -> bool

pub fn is_server_error(&self) -> bool

pub fn is_retryable(&self) -> bool

Retry guidance for the response. Mirrors the previous HttpError logic for backwards-compatible retry middleware.

pub fn problem_details(&self) -> Option<ProblemDetails>

Decode the generated RFC 9457 validation-problem profile without replacing a documented per-operation error in typed.

Returns None unless the response’s Content-Type is application/problem+json, which is how RFC 9457 identifies a problem document. Most third-party APIs return their errors as plain application/json, so this yields None against them by design — use typed for a documented per-operation error body, or body for the raw payload. Servers generated by this tool always emit the problem media type, so this succeeds against them.

Trait Implementations

impl<E: Clone> Clone for ApiError<E>

fn clone(&self) -> ApiError<E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Debug> Debug for ApiError<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: Debug> Display for ApiError<E>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<E: Debug> Error for ApiError<E>

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.