Enum OrderError 

#[non_exhaustive]
pub enum OrderError<AssetKey = AssetIndex, InstrumentKey = InstrumentIndex> {
    Connectivity(ConnectivityError),
    NotPlaced(NotPlacedReason),
    Rejected(ApiError<AssetKey, InstrumentKey>),
    UnsupportedOrderType(String),
    InvalidPrecision(PrecisionViolation),
    OutOfBounds(BoundsViolation),
    UnsupportedMarginEffect(MarginEffect),
}

Represents all errors that can be generated when cancelling or opening orders.

This is a subset of ClientError for order-specific operations. Use is_transient() to determine retry eligibility.

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.

Connectivity(ConnectivityError)

Connectivity-based error (timeout, socket failure, exchange offline), or a venue failure that leaves the order’s status unknown.

Transient — retry with backoff. See ConnectivityError for details. The order may or may not have reached the matching engine, so before resubmitting an open request, reconcile its state (open orders, fills); a blind retry can place it twice.

For an open request, this means the outcome is unknown, not that the open failed: see is_outcome_unknown. A client that knows the request never left returns NotPlaced instead.

NotPlaced(NotPlacedReason)

The order was not placed, and this is known rather than guessed: see NotPlacedReason.

Unlike Connectivity, it ends the order. Resubmitting the open request cannot place the order twice.

Rejected(ApiError<AssetKey, InstrumentKey>)

API-based error (rate limit, invalid instrument, order rejected, etc.).

Retry semantics depend on the specific ApiError variant. Only ApiError::RateLimit is transient; other variants are not.

UnsupportedOrderType(String)

The order type is not supported by this connector, or the venue refused it as a type it does not take for this account or instrument.

Non-transient — place a different order type. A connector usually returns this without sending the request (e.g., trailing stop orders on a connector that only supports market/limit); when the venue’s own refusal says so, it can also come back after the round trip.

InvalidPrecision(PrecisionViolation)

A quantity or price in the request has more precision than the venue accepts, so the client refused it without sending it.

Non-transient — change the request. A client that refuses this way never rounds a value itself, because rounding would place a different order than the one requested; it documents how to read the venue’s precision so the caller can round first.

OutOfBounds(BoundsViolation)

A value in the request is outside the range the venue accepts for the instrument, so the client refused it without sending it.

Non-transient — change the request. Unlike InvalidPrecision, which says a value is badly formed, this says a well-formed value is too small or too large: below a minimum price, quantity, notional or trailing offset, or above a maximum. The error carries the limit that was broken, so the caller can resize the order. A client checks only the rules it has loaded (see OrderRules); a request that passes can still be rejected by the venue.

UnsupportedMarginEffect(MarginEffect)

The request names a MarginEffect this client cannot honour, so it refused the order without sending it.

Non-transient — drop the effect (RequestOpen::margin_effect of None takes the client’s default) or send the order to a client that honours it. A client refuses rather than ignores an effect it cannot honour, because placing the order without it would borrow, or not repay, against the caller’s intent. Which effects a client honours is on its type: a spot or cash account takes only NoSideEffect, a venue with account-level margin takes none.

Implementations

impl<AssetKey, InstrumentKey> OrderError<AssetKey, InstrumentKey>

pub fn is_transient(&self) -> bool

Returns true if this error is likely transient and the operation may succeed if retried after a suitable backoff.

Transient errors

• Connectivity errors (timeout, socket, offline)
• Rejected(ApiError::RateLimit), though not before its retry_after

Non-transient errors

• Other Rejected errors (invalid instrument, insufficient balance, refused borrow, etc.)
• UnsupportedOrderType, InvalidPrecision, OutOfBounds and UnsupportedMarginEffect

NotPlaced is transient when the request was not sent, since a later send may get through, and not when the venue does not know the order.

pub fn is_outcome_unknown(&self) -> bool

Returns true if, as the answer to an open request, this error leaves the order’s outcome unknown: the order may be live at the venue.

Only Connectivity does. Every other error says the order was not placed.

Trait Implementations

impl<AssetKey: Clone, InstrumentKey: Clone> Clone for OrderError<AssetKey, InstrumentKey>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<AssetKey: Debug, InstrumentKey: Debug> Debug for OrderError<AssetKey, InstrumentKey>

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

Formats the value using the given formatter.

impl<'de, AssetKey, InstrumentKey> Deserialize<'de> for OrderError<AssetKey, InstrumentKey>

where AssetKey: Deserialize<'de>, InstrumentKey: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<AssetKey, InstrumentKey> Display for OrderError<AssetKey, InstrumentKey>

where ApiError<AssetKey, InstrumentKey>: Display,

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

Formats the value using the given formatter.

impl<AssetKey: Eq, InstrumentKey: Eq> Eq for OrderError<AssetKey, InstrumentKey>

impl<AssetKey, InstrumentKey> Error for OrderError<AssetKey, InstrumentKey>

where ApiError<AssetKey, InstrumentKey>: Error + 'static, Self: Debug + Display,

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<AssetKey, InstrumentKey> From<ApiError<AssetKey, InstrumentKey>> for OrderError<AssetKey, InstrumentKey>

fn from(source: ApiError<AssetKey, InstrumentKey>) -> Self

Converts to this type from the input type.

impl<AssetKey, InstrumentKey> From<ConnectivityError> for OrderError<AssetKey, InstrumentKey>

fn from(source: ConnectivityError) -> Self

Converts to this type from the input type.

impl<AssetKey, InstrumentKey> From<OrderError<AssetKey, InstrumentKey>> for InactiveOrderState<AssetKey, InstrumentKey>

fn from(value: OrderError<AssetKey, InstrumentKey>) -> Self

Converts to this type from the input type.

impl<AssetKey: Hash, InstrumentKey: Hash> Hash for OrderError<AssetKey, InstrumentKey>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<AssetKey: Ord, InstrumentKey: Ord> Ord for OrderError<AssetKey, InstrumentKey>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl<AssetKey: PartialEq, InstrumentKey: PartialEq> PartialEq for OrderError<AssetKey, InstrumentKey>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<AssetKey: PartialOrd, InstrumentKey: PartialOrd> PartialOrd for OrderError<AssetKey, InstrumentKey>

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<AssetKey, InstrumentKey> Serialize for OrderError<AssetKey, InstrumentKey>

where AssetKey: Serialize, InstrumentKey: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<AssetKey: PartialEq, InstrumentKey: PartialEq> StructuralPartialEq for OrderError<AssetKey, InstrumentKey>