Enum ApiError 

#[non_exhaustive]
pub enum ApiError {
    Response(Box<ErrorResponse>),
    Validation(String),
    Transport(TransportError),
    Serialization(Error),
    Url(ParseError),
    Refused(Refused),
    Sign(Box<dyn Error + Send + Sync>),
}

Core API error types shared across Polyoxide clients

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.

Response(Box<ErrorResponse>)

The server answered with an unsuccessful status. Its class is the status’s.

Validation(String)

The client refused the request before sending it: bad input, or missing configuration.

Transport(TransportError)

The transport failed: no response arrived, or its body could not be read. Its class is its kind’s.

Serialization(Error)

JSON serialization/deserialization error

Url(ParseError)

URL parsing error

Refused(Refused)

The throttle refused a cost no layer can ever hold, and nothing was sent.

Sign(Box<dyn Error + Send + Sync>)

An Authenticator could not sign the request, and nothing was sent. Carries the venue’s own error, which the venue’s From<ApiError> takes back out.

Implementations

impl ApiError

pub async fn from_response(response: Response) -> Self

Read an unsuccessful response whole, as ApiError::Response.

Trait Implementations

impl Classify for ApiError

The class each variant reports.

ApiError::Response follows the status rule, with any status outside 400–599 a Class::Decode (a 2xx that a caller found wanting, such as a ping whose body says it is not ok), and a 429’s wait its Retry-After. A 451 is not a fault: the venue does not serve the caller’s region, as designed. ApiError::Validation and ApiError::Sign are a Class::InvalidRequest: the client refused the request, or could not sign it, and nothing was sent.

Classify::retry_after is a response’s Retry-After whatever its status, and None for every other variant.

fn class(&self) -> Class

The class of this error.

fn is_fault(&self) -> bool

Whether this error is a fault, rather than the venue answering as designed. False only for defined outcomes, such as a Fill-And-Kill order that matched nothing, or a venue that does not serve the caller’s region. Alerting should key on this; retrying should not.

fn retry_after(&self) -> Option<Duration>

How long the server asked the caller to wait. Defaults to the class’s own; an error whose wait outlives its class, such as a ban that says when it lifts, overrides it. Never Some of zero.

fn is_retriable(&self) -> bool

Whether retrying could plausibly succeed, read from the class (see Class::is_retriable).

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.

impl From<ErrorResponse> for ApiError

fn from(response: ErrorResponse) -> Self

Converts to this type from the input type.

impl From<ParseError> for ApiError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<Refused> for ApiError

fn from(source: Refused) -> Self

Converts to this type from the input type.

impl From<TransportError> for ApiError

fn from(source: TransportError) -> Self

Converts to this type from the input type.