Struct ApiErrorBody 

#[non_exhaustive]
pub struct ApiErrorBody {
    pub error_message: String,
    pub error_code: Option<String>,
    pub reject_reason: Option<String>,
    pub extra: Map<String, Value>,
}

The JSON body OANDA returns for error responses.

All error responses carry errorMessage; some also carry errorCode and/or rejectReason. Order-related rejections include additional top-level fields (e.g. orderRejectTransaction, relatedTransactionIDs, lastTransactionID), which are preserved in ApiErrorBody::extra and can be decoded into a typed struct with ApiErrorBody::details.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

error_message: String

Human-readable description of the error.

error_code: Option<String>

Machine-readable error code, when provided.

reject_reason: Option<String>

The reason the request was rejected, when provided.

extra: Map<String, Value>

Any additional top-level fields of the error body.

Implementations

impl ApiErrorBody

pub fn details<T: DeserializeOwned>(&self) -> Option<T>

Attempts to decode the full error body into a typed view.

Useful for order endpoints, whose 400/404 responses carry reject transactions, e.g. CreateOrderRejectBody.

Trait Implementations

impl Clone for ApiErrorBody

fn clone(&self) -> ApiErrorBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ApiErrorBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiErrorBody

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApiErrorBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.