Enum ClientError 

#[non_exhaustive]
pub enum ClientError<AssetKey = AssetIndex, InstrumentKey = InstrumentIndex> {
    Connectivity(ConnectivityError),
    Api(ApiError<AssetKey, InstrumentKey>),
    TaskFailed(String),
    Internal(String),
    Truncated {
        limit: usize,
    },
    TruncatedSnapshot {
        limit: usize,
    },
}

Represents all errors produced by an ExecutionClient.

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.

eg/ Timeout.

Api(ApiError<AssetKey, InstrumentKey>)

API based error.

eg/ RateLimit.

TaskFailed(String)

A background task panicked or was cancelled during an operation.

This indicates a bug or unexpected runtime condition (e.g., a tokio spawn_blocking task panicked). The operation was not retried and the caller should treat this as non-recoverable, requiring operator attention.

Internal(String)

An opaque error from an upstream library that cannot be further classified.

This is a catch-all for errors that don’t fit into Self::Connectivity or Self::Api categories — typically because the upstream library (e.g., ibapi, binance-sdk) returns unstructured errors.

Conservatively treated as non-transient. If you encounter this error frequently, consider filing an issue to improve error classification.

Truncated

Activity pagination was truncated at the page limit.

The returned data from the underlying call is a partial result. This error indicates that more activities exist beyond the safety limit, typically due to a very long outage (>5000 fills). Callers should alert operators and consider manual reconciliation.

Fields

limit: usize

Maximum number of pages that were fetched before truncation.

TruncatedSnapshot

Open orders snapshot was truncated at the API’s row limit.

Unlike Self::Truncated (which applies to paginated activity fetches), this error indicates a single-request endpoint hit its maximum row count. Alpaca’s /v2/orders endpoint caps results at 500; accounts with more concurrent open orders will have an incomplete snapshot.

Callers should alert operators — an incomplete order snapshot can cause duplicate submissions, missed cancellations, or incorrect position sizing.

Fields

limit: usize

Maximum number of rows returned by the single-request endpoint.

Implementations

impl<AssetKey, InstrumentKey> ClientError<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.

The caller is responsible for retry limits and backoff strategy. This method classifies the error only — it does not implement policy.

Transient errors

• Connectivity errors (timeout, socket, offline)
• Api::RateLimit

Non-transient errors

• Other Api errors (invalid instrument, insufficient balance, etc.)
• TaskFailed (indicates a bug)
• Internal (unknown — conservatively non-transient)
• Truncated / TruncatedSnapshot

Trait Implementations

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

fn clone(&self) -> ClientError<AssetKey, InstrumentKey>

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 ClientError<AssetKey, InstrumentKey>

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

Formats the value using the given formatter.

impl<'de, AssetKey, InstrumentKey> Deserialize<'de> for ClientError<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 ClientError<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 ClientError<AssetKey, InstrumentKey>

impl<AssetKey, InstrumentKey> Error for ClientError<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 ClientError<AssetKey, InstrumentKey>

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

Converts to this type from the input type.

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

fn from(source: ConnectivityError) -> Self

Converts to this type from the input type.

impl<AssetKey: Hash, InstrumentKey: Hash> Hash for ClientError<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 ClientError<AssetKey, InstrumentKey>

fn cmp(&self, other: &ClientError<AssetKey, InstrumentKey>) -> 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.

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

fn eq(&self, other: &ClientError<AssetKey, InstrumentKey>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

fn partial_cmp( &self, other: &ClientError<AssetKey, InstrumentKey>, ) -> 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 ClientError<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 ClientError<AssetKey, InstrumentKey>