Enum ClientError 

pub enum ClientError<Endpoint: Debug + Display> {
    InvalidSystemId,
    InvalidApiKey,
    DisabledApiKey,
    ReadOnlyKey,
    BadApiKey,
    RateLimitExceeded,
    DonationModeRequired,
    InaccessibleSystemId,
    NotFound,
    UnrecognisedStatusCode(StatusCode, Option<String>),
    Reqwest(Error),
    Parse(Error),
    Write(Box<IntoInnerError<Writer<Vec<u8>>>>),
    RateLimitParse(RateLimitError),
    MissingField,
    EndpointSpecific(Endpoint),
}

Errors that can occur when using the Client.

Endpoint-Specific Errors

A ClientError may contain an endpoint-specific error.

Most endpoints return a ClientError with NoEndpointSpecificError, indicating that no endpoint-specific errors can result from using the endpoint.

Some endpoints have their own error types, such as AddOutputError, which is returned by the crate::Client::add_outputs endpoint.

Variants

InvalidSystemId

The provided system ID is invalid.

InvalidApiKey

The provided API key is invalid.

DisabledApiKey

The provided API key has not been enabled in the Settings.

ReadOnlyKey

The provided API key is a read-only key and cannot access the requested service which updates system data. Use the standard key to update system data.

BadApiKey

The provided system ID and API key combination is invalid, or the API key is missing, invalid, or inactive.

RateLimitExceeded

The maximum number of requests per hour has been reached for the API key.

The rate limit will refresh at the time specified by the returned RateLimit struct.

DonationModeRequired

Donation mode is required for this request.

InaccessibleSystemId

Another system ID was requested by an account without donation mode enabled.

NotFound

The requested data were not found.

UnrecognisedStatusCode(StatusCode, Option<String>)

An unrecognised unsuccessful HTTP status code was returned.

Reqwest(Error)

An error occurred while making the request.

Parse(Error)

Deserialisation error.

Write(Box<IntoInnerError<Writer<Vec<u8>>>>)

Error writing CSV data to a buffer.

RateLimitParse(RateLimitError)

Failed to parse rate limit information from the response’s HTTP headers.

MissingField

Missing field in API response.

EndpointSpecific(Endpoint)

An endpoint-specific error occurred.

Trait Implementations

impl<Endpoint: Debug + Debug + Display> Debug for ClientError<Endpoint>

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

Formats the value using the given formatter.

impl<Endpoint: Debug + Display> Display for ClientError<Endpoint>

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

Formats the value using the given formatter.

impl<Endpoint> Error for ClientError<Endpoint>

where Endpoint: 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<AddOutputError> for ClientError<AddOutputError>

fn from(error: AddOutputError) -> Self

Converts to this type from the input type.

impl From<AddStatusError> for ClientError<AddStatusError>

fn from(error: AddStatusError) -> Self

Converts to this type from the input type.

impl<Endpoint> From<Error> for ClientError<Endpoint>

where Endpoint: Debug + Display,

fn from(error: Error) -> Self

Converts to this type from the input type.

impl<Endpoint> From<Error> for ClientError<Endpoint>

where Endpoint: Debug + Display,

fn from(error: Error) -> Self

Converts to this type from the input type.

impl<Endpoint> From<IntoInnerError<Writer<Vec<u8>>>> for ClientError<Endpoint>

where Endpoint: Debug + Display,

fn from(error: IntoInnerError<Writer<Vec<u8>>>) -> Self

Converts to this type from the input type.

impl From<PostSystemError> for ClientError<PostSystemError>

fn from(error: PostSystemError) -> Self

Converts to this type from the input type.

impl<Endpoint> From<RateLimitError> for ClientError<Endpoint>

where Endpoint: Debug + Display,

fn from(error: RateLimitError) -> Self

Converts to this type from the input type.