Enum ApiError 

#[non_exhaustive]
pub enum ApiError {
    Unauthorized,
    RateLimit {
        retry_after: Option<u64>,
    },
    NotFound,
    ServerError {
        status: u16,
    },
    NetworkError(Error),
    ParseError(String),
}

All errors that can be returned by the WakaTime API client.

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.

Unauthorized

The API key is invalid or was not provided. Maps to HTTP 401.

RateLimit

The API rate limit has been exceeded. Maps to HTTP 429.

retry_after contains the number of seconds to wait before retrying, if the server included a Retry-After header.

Fields

retry_after: Option<u64>

Seconds to wait before retrying, if known.

NotFound

The requested resource was not found. Maps to HTTP 404.

ServerError

An unexpected server-side error occurred. Maps to HTTP 5xx.

Fields

status: u16

The raw HTTP status code returned by the server.

NetworkError(Error)

A network-level error occurred (connection refused, timeout, DNS, etc.).

ParseError(String)

The server returned a response that could not be deserialized.

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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 ApiError

fn from(source: Error) -> Self

Converts to this type from the input type.