Struct BinanceWs 

pub struct BinanceWs { /* private fields */ }

Binance WebSocket client wrapper

Implementations

impl BinanceWs

pub fn new(url: String) -> Self

Creates a new Binance WebSocket client

pub fn new_with_auth(url: String, binance: Arc<Binance>) -> Self

Creates a WebSocket client with a listen key manager

pub async fn connect(&self) -> Result<()>

Connects to the WebSocket server

pub async fn disconnect(&self) -> Result<()>

Disconnects from the WebSocket server

pub async fn connect_user_stream(&self) -> Result<()>

Connects to the user data stream

pub async fn close_user_stream(&self) -> Result<()>

Closes the user data stream

pub async fn get_listen_key(&self) -> Option<String>

Returns the active listen key, when available

pub async fn subscribe_ticker(&self, symbol: &str) -> Result<()>

Subscribes to the ticker stream for a symbol

pub async fn subscribe_all_tickers(&self) -> Result<()>

Subscribes to the 24-hour ticker stream for all symbols

pub async fn subscribe_trades(&self, symbol: &str) -> Result<()>

Subscribes to real-time trade executions for a symbol

pub async fn subscribe_agg_trades(&self, symbol: &str) -> Result<()>

Subscribes to the aggregated trade stream for a symbol

pub async fn subscribe_orderbook( &self, symbol: &str, levels: u32, update_speed: &str, ) -> Result<()>

Subscribes to the order book depth stream

pub async fn subscribe_orderbook_diff( &self, symbol: &str, update_speed: Option<&str>, ) -> Result<()>

Subscribes to the diff order book stream

pub async fn subscribe_kline(&self, symbol: &str, interval: &str) -> Result<()>

Subscribes to Kline (candlestick) data for a symbol

pub async fn subscribe_mini_ticker(&self, symbol: &str) -> Result<()>

Subscribes to the mini ticker stream for a symbol

pub async fn subscribe_all_mini_tickers(&self) -> Result<()>

Subscribes to the mini ticker stream for all symbols

pub async fn unsubscribe(&self, stream: String) -> Result<()>

Cancels an existing subscription

pub fn receive(&self) -> Option<Value>

Receives the next available message

pub fn is_connected(&self) -> bool

Indicates whether the WebSocket connection is active

pub fn state(&self) -> WsConnectionState

Returns the current connection state.

pub fn subscriptions(&self) -> Vec<String>

Returns the list of active subscriptions.

Returns a vector of subscription channel names that are currently active. This method retrieves the actual subscriptions from the underlying WsClient’s subscription manager, providing accurate state tracking.

pub fn subscription_count(&self) -> usize

Returns the number of active subscriptions.

pub async fn get_cached_ticker(&self, symbol: &str) -> Option<Ticker>

Returns cached ticker snapshot

pub async fn get_all_cached_tickers(&self) -> HashMap<String, Ticker>

Returns all cached ticker snapshots

Trait Implementations

impl Debug for BinanceWs

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

Formats the value using the given formatter.