Enum UsdmError 

#[non_exhaustive]
pub enum UsdmError {
    Api(ApiError),
    Venue {
        status: u16,
        code: i64,
        msg: String,
    },
    RateLimited {
        retry_after: Option<Duration>,
    },
    IpBanned {
        retry_after: Option<Duration>,
    },
    RegionBlocked {
        msg: String,
    },
    Forbidden {
        msg: String,
    },
}

Error type for USDⓈ-M futures API operations.

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.

Api(ApiError)

Transport, decoding, or an error body in a shape Binance does not use.

Venue

Binance refused the request with its {"code", "msg"} body: an unknown symbol is 400 with code -1121.

Fields

status: u16

HTTP status.

code: i64

Binance’s error code, always negative.

msg: String

Binance’s message, clipped to 512 bytes.

RateLimited

Still answered 429 after the retry schedule ran out.

Fields

retry_after: Option<Duration>

The response’s Retry-After.

IpBanned

418: Binance has banned this IP for continuing after a 429. Every request on the same WeightBudget waits until the ban lifts.

Fields

retry_after: Option<Duration>

The response’s Retry-After. The docs give bans of 2 minutes to 3 days.

RegionBlocked

451: Binance does not serve the caller’s location.

Fields

msg: String

The response body, clipped to 512 bytes.

Forbidden

403: Binance’s web application firewall refused the request.

Fields

msg: String

The response body, clipped to 512 bytes.

Implementations

impl UsdmError

pub fn code(&self) -> Option<i64>

Binance’s error code, for a Venue error.

Trait Implementations

impl Classify for UsdmError

Api delegates, and Venue follows the status rule with Binance’s code in decimal. A 429 is RateLimited, and a ban, a region block and a firewall refusal are all Restricted: Binance documents its 403 as the firewall’s, not as a credential failure (D14). So a 429, and a 408, 425 or 5xx however its body is shaped, are retriable, and a ban, a region block and a firewall refusal are not: sending again does not change them, and sending after a 418 lengthens the ban.

A region block is the venue answering as designed, so it is not a fault. A 429’s or a ban’s Classify::retry_after is its Retry-After, clamped to 3 days: for a ban, the time it lifts.

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 UsdmError

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

Formats the value using the given formatter.

impl Display for UsdmError

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

Formats the value using the given formatter.

impl Error for UsdmError

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<ApiError> for UsdmError

Binance’s one decode: an unsuccessful response, by status first.

418, 429, 451 and 403 go by status alone: their bodies were not observed from a test IP, and the status is what decides what a caller should do. Anything else with Binance’s {code, msg} body is Venue; any other body stays core’s ApiError::Response, its message and body clipped and its Retry-After clamped to 3 days, as every arm reads it. Every other ApiError stays core’s.

A 418’s body is Binance’s -1003 text, which names when the ban ends. The error’s fields have no room for it, so it is logged at WARN under polyoxide_binance::usdm::error; the send loop warns of the hold itself, naming the path.

fn from(err: ApiError) -> Self

Converts to this type from the input type.