Enum Error 

#[non_exhaustive]
pub enum Error {
    Transport(Error),
    Api {
        status: StatusCode,
        request_id: Option<String>,
        body: ApiErrorBody,
    },
    Decode {
        source: Error,
        body: String,
    },
    Stream(String),
    Config(String),
}

The unified error type returned by every SDK operation.

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(Error)

The HTTP request could not be performed (connection, TLS, timeout, …).

Api

OANDA answered with a non-success HTTP status.

The parsed error body is available in Error::Api::body; the raw payload of order-reject responses can be recovered with ApiErrorBody::details.

Fields

status: StatusCode

HTTP status code of the response.

request_id: Option<String>

Value of the RequestID response header, when present.

body: ApiErrorBody

Parsed error body.

Decode

A 2xx response body could not be deserialized into the expected type.

Fields

source: Error

The underlying deserialization error.

body: String

The raw response body, kept verbatim for debugging.

Stream(String)

A streaming connection violated the expected protocol.

Config(String)

The client was configured with invalid values.

Implementations

impl Error

pub fn status(&self) -> Option<StatusCode>

The HTTP status code associated with this error, if any.

pub fn request_id(&self) -> Option<&str>

The RequestID header OANDA attached to the failing response, if any.

pub fn is_rate_limited(&self) -> bool

Whether this error was caused by OANDA’s rate limiting (HTTP 429).

OANDA allows 120 REST requests per second and 2 new connections per second per IP address. The client’s built-in rate limiter (see ClientBuilder) keeps you below those limits by default, so this should only occur when rate limiting was disabled or other processes share the same IP.

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

fn from(source: Error) -> Self

Converts to this type from the input type.