Enum EsiError 

#[non_exhaustive]
pub enum EsiError {
    EmptyClientValue(String),
    MissingAuthenticationFlowInformation,
    EmptySpec,
    InvalidJWT(String),
    JwtValidationFailed(Error),
    InvalidStatusCode(u16),
    InvalidUserAgentHeader(InvalidHeaderValue),
    ReqwestError(Error),
    HttpMethodError(InvalidMethod),
    MissingAuthentication,
    UnknownOperationID(String),
    FailedSpecParse(String),
    FailedJsonParse(Error),
    Timestamp(SystemTimeError),
    HeaderReadError(ToStrError),
    HeaderParseError(String, ParseIntError),
    ErrorLimited(i64),
    RateLimited {
        group: Option<String>,
        retry_after_secs: Option<u64>,
    },
    AccessTokenExpired,
    NoRefreshTokenAvailable,
}

Errors that can occur when dealing with ESI.

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.

EmptyClientValue(String)

Error that can be thrown if the EsiBuilder struct is invalid when .build() is called.

MissingAuthenticationFlowInformation

Error that can be thrown if the EsiBuilder struct is invalid when .build() is called. You need to specify either a client secret or enable application auth

EmptySpec

You have to retrieve the ESI spec via Esi::update_spec before making this call.

InvalidJWT(String)

Error that could be thrown if the access token JWT from SSO is invalid, whether due to tampering or some other reason.

JwtValidationFailed(Error)

Validation of the JWT failed.

InvalidStatusCode(u16)

Error that can be thrown by any function that makes HTTP calls our to external resources for response codes that aren’t valid as defined [by reqwest]. [by reqwest]: https://docs.rs/reqwest/0.10.6/reqwest/struct.StatusCode.html#method.is_success

InvalidUserAgentHeader(InvalidHeaderValue)

Error for if the provided user-agent header value has invalid characters.

ReqwestError(Error)

Error for if the underlying reqwest::Client could not be constructed.

HttpMethodError(InvalidMethod)

Error for if the String cannot be converted into a valid HTTP method.

MissingAuthentication

Error for if a request is made to an endpoint that requires authentication, but no access token is present in the Esi struct.

UnknownOperationID(String)

Error for not finding the passed operationId in the ESI OpenAPI spec.

FailedSpecParse(String)

Error for being unable to parse the OpenAPI spec from ESI.

FailedJsonParse(Error)

Error for being unable to parse JSON from anywhere.

Timestamp(SystemTimeError)

Error for being unable to get the current timestamp.

HeaderReadError(ToStrError)

Error for being unable to read response header.

HeaderParseError(String, ParseIntError)

Error for being unable to parse header value.

ErrorLimited(i64)

Error for enforcing ESI error limit

RateLimited

ESI answered 429 Too Many Requests: the rate-limit bucket for this route group is empty. Wait retry_after_secs (from the Retry-After header, when present) before calling routes in group again.

Fields

group: Option<String>

Rate-limit group from the X-Ratelimit-Group header, if present.

retry_after_secs: Option<u64>

Seconds to wait, from the Retry-After header, if present.

AccessTokenExpired

Error for the access token being used after expiring (and therefore being unable to be used for ESI) and no refresh token being present to fetch another access token.

NoRefreshTokenAvailable

Error when a access_token needs to be refreshed, but no refresh token could be found to refresh the access token

Trait Implementations

impl Debug for EsiError

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

Formats the value using the given formatter.

impl Display for EsiError

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

Formats the value using the given formatter.

impl Error for EsiError

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 EsiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EsiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for EsiError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for EsiError

fn from(source: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<InvalidMethod> for EsiError

fn from(source: InvalidMethod) -> Self

Converts to this type from the input type.

impl From<SystemTimeError> for EsiError

fn from(source: SystemTimeError) -> Self

Converts to this type from the input type.

impl From<ToStrError> for EsiError

fn from(source: ToStrError) -> Self

Converts to this type from the input type.