Enum Error 

#[non_exhaustive]
pub enum Error {
    Transport(TransportError),
    Encode(Box<dyn Error + Send + Sync>),
    Decode(Box<dyn Error + Send + Sync>),
    Api {
        code: String,
        message: String,
    },
    HttpStatus {
        status: StatusCode,
        body: String,
    },
    Configuration(String),
}

Errors that can occur while making an OKX API request.

The enum is #[non_exhaustive] so new variants can be added without a breaking change. Downstream code can match on Error::Api and inspect the OKX error code (kept as a String, since OKX codes are not guaranteed to be parseable integers).

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.

Transport(TransportError)

The underlying HTTP transport failed (connection, TLS, timeout, …).

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

The request could not be encoded (query string or JSON body).

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

The response body could not be decoded into the expected model.

Api

OKX returned a non-zero response code.

Fields

code: String

OKX error code (e.g. "50011"). Kept as a string deliberately.

message: String

Human-readable error message from OKX.

HttpStatus

The HTTP response had a non-success status before the OKX response envelope could be decoded.

Fields

status: StatusCode

HTTP response status code.

body: String

Response body, decoded lossily as UTF-8 for diagnostics.

Configuration(String)

The client was used in an invalid way (e.g. an authenticated endpoint was called without credentials).

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, __formatter: &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<TransportError> for Error

fn from(source: TransportError) -> Self

Converts to this type from the input type.