Enum ApiError

#[non_exhaustive]
pub enum ApiError<E>
where
    E: Error + Send + Sync + 'static,
{
    Client {
        source: E,
    },
    UrlParse {
        source: ParseError,
    },
    Body {
        source: BodyError,
    },
    Json {
        source: Error,
    },
    Server {
        msg: String,
    },
    ServerService {
        status: StatusCode,
        data: Vec<u8>,
    },
    DataType {
        source: Error,
        typename: &'static str,
    },
}

Errors which may occur when using API endpoints.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Client

The client encountered an error.

Fields

source: E

The client error.

UrlParse

The URL failed to parse.

Fields

source: ParseError

The source of the error.

Body

Body data could not be created.

Fields

source: BodyError

The source of the error.

Json

JSON deserialization from API failed.

Fields

source: Error

The source of the error.

Server

Server returned an error message.

Fields

msg: String

The error message from the server.

ServerService

Server returned an error without JSON information.

Fields

status: StatusCode

The status code for the return.

data: Vec<u8>

The error data from the server.

DataType

Failed to parse an expected data type from JSON.

Fields

source: Error

The source of the error.

typename: &'static str

The name of the type that could not be deserialized.

Implementations

impl<E> ApiError<E>

where E: Error + Send + Sync + 'static,

pub fn client(source: E) -> Self

Create an API error in a client error.

pub fn map_client<F, W>(self, f: F) -> ApiError<W>

where F: FnOnce(E) -> W, W: Error + Send + Sync + 'static,

Wrap a client error in another wrapper.

Trait Implementations

impl<E> Debug for ApiError<E>

where E: Error + Send + Sync + 'static + Debug,

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

Formats the value using the given formatter.

impl<E> Display for ApiError<E>

where E: Error + Send + Sync + 'static,

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

Formats the value using the given formatter.

impl<E> Error for ApiError<E>

where E: Error + Send + Sync + 'static + Error, Self: Debug + Display,

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<BodyError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: BodyError) -> Self

Converts to this type from the input type.

impl<E> From<Error> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: Error) -> Self

Converts to this type from the input type.

impl<E> From<ParseError> for ApiError<E>

where E: Error + Send + Sync + 'static,

fn from(source: ParseError) -> Self

Converts to this type from the input type.