Struct BinanceFuturesWebSocketClient 

pub struct BinanceFuturesWebSocketClient { /* private fields */ }

Binance Futures WebSocket client for JSON market data streams.

Manages a pool of up to 20 connections, each supporting up to 200 streams. New connections are created automatically when subscribing exceeds the current connection’s stream limit. All connections feed into a single output stream, transparent to the data client.

Implementations

impl BinanceFuturesWebSocketClient

pub fn new( product_type: BinanceProductType, environment: BinanceEnvironment, api_key: Option<String>, api_secret: Option<String>, url_override: Option<String>, heartbeat: Option<u64>, transport_backend: TransportBackend, ) -> Result<Self>

Creates a new BinanceFuturesWebSocketClient instance.

Errors

Returns an error if:

• product_type is not a futures type (UsdM or CoinM).
• Credential creation fails.

pub const fn product_type(&self) -> BinanceProductType

Returns the product type (UsdM or CoinM).

pub fn is_active(&self) -> bool

Returns whether any connection in the pool is active.

pub fn is_closed(&self) -> bool

Returns whether all connections in the pool are closed.

pub fn subscription_count(&self) -> usize

Returns the total number of confirmed subscriptions across all connections.

pub async fn connect(&mut self) -> BinanceWsResult<()>

Connects the first WebSocket connection in the pool.

Errors

Returns an error if connection fails.

pub async fn close(&mut self) -> BinanceWsResult<()>

Closes all WebSocket connections in the pool.

Errors

Returns an error if disconnect fails.

pub async fn subscribe(&self, streams: Vec<String>) -> BinanceWsResult<()>

Subscribes to the specified streams.

Streams are distributed across pool connections. New connections are created automatically when existing ones reach the 200-stream limit, up to a maximum of 20 connections.

Errors

Returns an error if the pool is exhausted or command delivery fails.

pub async fn unsubscribe(&self, streams: Vec<String>) -> BinanceWsResult<()>

Unsubscribes from the specified streams.

Errors

Returns an error if command delivery fails.

pub fn stream( &self, ) -> impl Stream<Item = BinanceFuturesWsStreamsMessage> + 'static

Returns a stream of messages from all WebSocket connections.

This method can only be called once per connection lifecycle. Subsequent calls return an empty stream.

Panics

Panics if the internal output receiver mutex is poisoned.

pub fn cache_instruments(&self, instruments: &[InstrumentAny])

Bulk initialize the instrument cache.

pub fn cache_instrument(&self, instrument: InstrumentAny)

Update a single instrument in the cache.

pub fn instruments_cache(&self) -> Arc<AtomicMap<Ustr, InstrumentAny>>

Returns a shared reference to the instruments cache.

pub fn get_instrument(&self, symbol: &str) -> Option<InstrumentAny>

Returns an instrument from the cache by raw symbol.

Trait Implementations

impl Clone for BinanceFuturesWebSocketClient

fn clone(&self) -> BinanceFuturesWebSocketClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinanceFuturesWebSocketClient

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

Formats the value using the given formatter.