Enum Error 

pub enum Error {
    Api {
        code: i64,
        msg: String,
    },
    Http {
        status: u16,
        body: String,
    },
    InvalidHeaderValue(InvalidHeaderValue),
    Io(Error),
    MissingCredentials,
    Msg(String),
    RateLimited {
        retry_after_ms: u64,
    },
    RateLimitUnsatisfiable {
        cost: u32,
        burst: u32,
    },
    Reqwest(Error),
    SerdeJson(Error),
    TooManyPages {
        max: usize,
    },
    SerdeUrlEncoded(Error),
    SerdePathToError(Error<Error>),
}

Errors returned by http::Client.

Variants

Api

Bybit answered with a non-zero retCode (see ret_code).

Fields

code: i64

Bybit retCode.

msg: String

Bybit retMsg.

Http

A non-2xx HTTP response whose body is not a Bybit error envelope (e.g. an HTML page from a CDN or gateway). body may be truncated.

Fields

status: u16

HTTP status code.

body: String

Response body, truncated to 1 KiB.

InvalidHeaderValue(InvalidHeaderValue)

A header value (API key, signature, referer) is not a valid HTTP header.

Io(Error)

I/O error.

MissingCredentials

A private endpoint was called on a client created without api_key/api_secret.

Msg(String)

Other error with a message.

RateLimited

The local rate limiter rejected the request before it was sent. retry_after_ms is the estimated wait until capacity is available.

Fields

retry_after_ms: u64

Estimated wait until the bucket has capacity, milliseconds.

RateLimitUnsatisfiable

The local rate limiter can never let this request through: its cost exceeds the bucket’s burst, or the bucket does not refill. Retrying will not help; adjust RateLimiterConfig.

Fields

cost: u32

Cost of the request (e.g. number of orders in a batch).

burst: u32

Burst capacity of the bucket.

Reqwest(Error)

Transport error (connection, timeout, TLS, …).

SerdeJson(Error)

JSON (de)serialization error.

TooManyPages

A *_all pagination helper fetched max pages without reaching the end.

Fields

max: usize

The page limit, MAX_PAGES.

SerdeUrlEncoded(Error)

Query string serialization error.

SerdePathToError(Error<Error>)

JSON deserialization error with the path of the offending field.

Implementations

impl Error

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

The Bybit retCode of an Error::Api (see ret_code).

pub fn is_timestamp_error(&self) -> bool

Bybit rejected the request timestamp (retCode 10002): the local clock is off; see http::Client::sync_time.

pub fn is_rate_limited(&self) -> bool

A rate limit was hit: locally (Error::RateLimited), by Bybit (retCode 10006/10018) or as HTTP 429.

pub fn is_not_modified(&self) -> bool

The request was refused because the value is already set (e.g. “leverage not modified”); usually this can be treated as success.

pub fn is_retryable(&self) -> bool

Sending the same request again later may succeed: network errors and timeouts, rate limits, server errors (HTTP 5xx, retCode 10016) and timestamp errors (after sync_time).

For orders a timeout does not prove the order was not placed: check it (e.g. by orderLinkId) before placing it again.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<&str> for Error

fn from(msg: &str) -> Self

Converts to this type from the input type.

impl From<APIErrorResponse> for Error

fn from(resp: APIErrorResponse) -> Self

Converts to this type from the input type.

impl From<Error<Error>> for Error

fn from(err: Error<Error>) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<InvalidHeaderValue> for Error

fn from(err: InvalidHeaderValue) -> Self

Converts to this type from the input type.

impl From<String> for Error

fn from(msg: String) -> Self

Converts to this type from the input type.