Enum Error 

#[non_exhaustive]
pub enum Error {
    MissingApiKey,
    InvalidApiKey,
    RateLimited {
        retry_after: Option<Duration>,
    },
    Api {
        status: u16,
        cause: String,
    },
    Http(Error),
    Decode(Error),
}

Errors returned by the Hypixel SDK.

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.

MissingApiKey

A method requiring authentication was called without an API key configured.

InvalidApiKey

The configured API key was rejected by the API (HTTP 403).

RateLimited

The request was rate limited (HTTP 429).

Fields

retry_after: Option<Duration>

Suggested wait duration parsed from the Retry-After header, if present.

Api

The API responded with a non-success status and an error cause.

Fields

status: u16

HTTP status code returned by the API.

cause: String

The cause field from the API response body, if available.

Http(Error)

The request could not be sent or the connection failed.

Decode(Error)

The response body could not be deserialized into the expected type.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.