Struct SubscriptionOptions

#[repr(align(64))]
pub struct SubscriptionOptions {

    pub id: String,
    pub symbols: SmallVec<[String; 8]>,
    pub subscription_type: SubscriptionType,
    pub request_id: Option<u64>,
    pub depth: Option<u32>,
    pub update_speed_ms: Option<u64>,
    pub snapshot_only: bool,
    pub realtime_only: bool,
    pub format: Option<String>,
    pub api_key: Option<String>,
    pub test: bool,
    pub interval: Option<String>,
    pub use_combined_streams: bool,
}

Cache-line aligned standardized subscription options Designed to work consistently across different exchange implementations

Fields

id: String

Unique identifier for the subscription

symbols: SmallVec<[String; 8]>

List of symbols to subscribe to

subscription_type: SubscriptionType

Type of subscription

request_id: Option<u64>

Optional request ID for tracking responses

depth: Option<u32>

Depth level for order book subscriptions

update_speed_ms: Option<u64>

Update speed in milliseconds (e.g., 100ms, 1000ms)

snapshot_only: bool

Whether to only send snapshot data (no real-time updates)

realtime_only: bool

Whether to only send real-time data (no initial snapshot)

format: Option<String>

Optional format specifier (e.g., “DEFAULT”, “SIMPLE”)

api_key: Option<String>

Optional API key for authenticated streams

test: bool

Whether this is a test subscription

interval: Option<String>

Interval for kline subscriptions (e.g., “1m”, “1h”, “1d”)

use_combined_streams: bool

Whether to use combined streams (for multiple symbols)

Trait Implementations

impl Clone for SubscriptionOptions

fn clone(&self) -> SubscriptionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionOptions

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

Formats the value using the given formatter.

impl Default for SubscriptionOptions

fn default() -> Self

Returns the “default value” for a type.