Enum speedrun_api::api::ApiError

#[non_exhaustive]
pub enum ApiError<E> where
    E: Error + Send + Sync + 'static, {
    Body(BodyError),
    Client(E),
    Json(Error),
    Parse(ParseError),
    SpeedrunApi(String),
    Unknown(Value),
    DataType {
        source: Error,
        typename: &'static str,
    },
    RequiresAuthentication,
}

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.

Json(Error)

JSON deserialization failed

Parse(ParseError)

The URL failed to parse.

SpeedrunApi(String)

Speedrun.com returned an error

Unknown(Value)

Speedrun.com returned an unknown error

DataType

Fields

source: Error

The source of the error

typename: &'static str

The name of the type that could not be deserialized.

Failed parsing data type from JSON

RequiresAuthentication

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

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> Debug for ApiError<E> where
    E: Error + Send + Sync + 'static, 

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, 

fn source(&self) -> Option<&(dyn Error + 'static)>

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 self, req: &mut Demand<'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<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.