Enum Error

pub enum Error<E = ()> {
    InvalidRequest(String),
    CommunicationError(Error),
    InvalidUpgrade(Error),
    ErrorResponse(ResponseValue<E>),
    ResponseBodyError(Error),
    InvalidResponsePayload(Bytes, Error),
    UnexpectedResponse(Response),
    Custom(String),
}

Error produced by generated client methods.

The type parameter may be a struct if there’s a single expected error type or an enum if there are multiple valid error types. It can be the unit type if there are no structured returns expected.

Variants

InvalidRequest(String)

The request did not conform to API requirements.

CommunicationError(Error)

A server error either due to the data, or with the connection.

InvalidUpgrade(Error)

An expected response when upgrading connection.

ErrorResponse(ResponseValue<E>)

A documented, expected error response.

ResponseBodyError(Error)

Encountered an error reading the body for an expected response.

InvalidResponsePayload(Bytes, Error)

An expected response code whose deserialization failed.

UnexpectedResponse(Response)

A response not listed in the API description. This may represent a success or failure response; check status().is_success().

Custom(String)

A custom error from a consumer-defined hook.

Implementations

impl<E> Error<E>

pub fn status(&self) -> Option<StatusCode>

Returns the status code, if the error was generated from a response.

pub fn into_untyped(self) -> Error

Converts this error into one without a typed body.

This is useful for unified error handling with APIs that distinguish various error response bodies.

Trait Implementations

impl<E> Debug for Error<E>

where ResponseValue<E>: ErrorFormat,

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

Formats the value using the given formatter.

impl<E> Display for Error<E>

where ResponseValue<E>: ErrorFormat,

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

Formats the value using the given formatter.

impl<E> Error for Error<E>

where ResponseValue<E>: ErrorFormat,

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<E> From<Error> for Error<E>

fn from(e: Error) -> Error<E>

Converts to this type from the input type.

impl<E> From<Infallible> for Error<E>

fn from(x: Infallible) -> Error<E>

Converts to this type from the input type.

impl<E> From<InvalidHeaderValue> for Error<E>

fn from(e: InvalidHeaderValue) -> Error<E>

Converts to this type from the input type.