Enum ApiError

#[non_exhaustive]
pub enum ApiError<E>
where
    E: Error + Send + Sync + 'static,
{
    Body(BodyError),
    Client(E),
    Parse(ParseError),
    RequiresAuthentication,
    Response {
        source: ResponseError,
        url: Uri,
    },
}

Errors that occur from 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.

Body(BodyError)

Error creating body data

Client(E)

The client encountered an error.

Parse(ParseError)

The URL failed to parse.

RequiresAuthentication

The endpoint requires an API key to use, but none was provided.

Response

Error in the HTTP response

Fields

source: ResponseError

Source of the error

url: Uri

URL of the error

Implementations

impl<E> ApiError<E>

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

pub fn client(source: E) -> Self

Create an API error from a client error

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 + Display,

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, 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 From<ApiError<RestError>> for SpeedrunApiError

fn from(source: ApiError<RestError>) -> 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.