Enum StreamTerminationReason 

#[non_exhaustive]
pub enum StreamTerminationReason {
    ReconnectBudgetExhausted {
        attempts: u32,
        last_error: String,
    },
    Error(String),
}

Why an account event stream ended.

Delivered in-band as the payload of AccountEventKind::StreamTerminated so that stream death is a programmatic signal on the account feed rather than a log-only event. A consumer can react (re-sync via REST, re-establish the stream, halt trading) according to its own policy — the library reports why the stream ended without prescribing the response.

Only in-band-deliverable terminations are represented

Every variant here is a termination the library can actually deliver to a consumer that is still listening. A consumer-initiated drop is deliberately not a variant: by the time a stream task observes the drop, the receiving half of the channel is already gone, so a StreamTerminated send would be a guaranteed no-op. StreamTerminated therefore always means “the stream died while you were still listening”.

#[non_exhaustive] so venues may distinguish further termination causes in future without a breaking change (e.g. a venue able to signal a graceful shutdown over a still-open channel).

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.

ReconnectBudgetExhausted

A venue with built-in reconnection exhausted its retry budget and gave up.

Emitted by venues that reconnect internally (e.g. Binance spot/margin, Alpaca) once the final attempt fails. last_error is the most recent underlying failure; attempts is the number of reconnects tried before surrendering. The stream will not recover on its own — the consumer must re-establish it.

Fields

attempts: u32

Number of reconnect attempts made before giving up.

last_error: String

The most recent underlying error that triggered surrender.

Error(String)

The stream ended on an unrecoverable error with no automatic recovery.

Emitted by venues without library-managed reconnection — e.g. IBKR (the underlying subscription errored and the client does not retry), Hyperliquid (the SDK’s internal reconnection gave up and closed the channel), or the mock exchange (its broadcast stream lagged past the buffer). The consumer is responsible for any re-establishment.

Trait Implementations

impl Clone for StreamTerminationReason

fn clone(&self) -> StreamTerminationReason

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamTerminationReason

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamTerminationReason

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamTerminationReason

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

Formats the value using the given formatter.

impl Eq for StreamTerminationReason

impl Error for StreamTerminationReason

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<ExchangeKey, AssetKey, InstrumentKey> From<StreamTerminationReason> for AccountEventKind<ExchangeKey, AssetKey, InstrumentKey>

fn from(value: StreamTerminationReason) -> Self

Converts to this type from the input type.

impl Hash for StreamTerminationReason

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 Ord for StreamTerminationReason

fn cmp(&self, other: &StreamTerminationReason) -> 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 PartialEq for StreamTerminationReason

fn eq(&self, other: &StreamTerminationReason) -> 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 PartialOrd for StreamTerminationReason

fn partial_cmp(&self, other: &StreamTerminationReason) -> 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 Serialize for StreamTerminationReason

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StreamTerminationReason