Struct ApiError 

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

Envelope for an API response we received but couldn’t (or didn’t) treat as success.

ApiError<E> is returned whenever the server actually responded — whether the status was non-2xx, or the 2xx body failed to deserialize into the expected type. status, headers, and body are always populated so callers can inspect what the server actually sent without having to hack the generated client. typed is Some(_) when the raw body was successfully parsed into a per-operation error type; parse_error records why parsing failed when not. 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

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 problem_details(&self) -> Option<ProblemDetails>

Decode the generated RFC 9457 validation-problem profile without disturbing a documented typed error.

Only the application/problem+json media type is accepted. Arbitrary JSON error bodies are deliberately not reclassified as Problem Details.

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.