Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

Represents an active WebSocket connection to Binance.

Implementations

impl WebSocketConnection

Represents a WebSocket connection to the Binance WebSocket API. This struct encapsulates the WebSocket stream and provides methods for subscribing to mini ticker streams, receiving messages, and closing the connection.

pub fn new(ws_stream: WebSocketStream<MaybeTlsStream<TcpStream>>) -> Self

Creates a new BinanceWebSocketConnection

pub async fn subscribe_mini_ticker_stream<K: AsRef<str>>( &mut self, id: i64, tickers: &[K], ) -> Result<(), Error>

Subscribes to the mini ticker stream for the specified symbol IDs.

This method sends a subscription request to the Binance WebSocket API for the specified symbol IDs. Each symbol ID is transformed into a mini ticker stream identifier before being sent.

Parameters

• id: A unique identifier for the subscription request.
• tickers: A slice of symbol IDs to subscribe to.

Errors

Returns a tungstenite::Error if the WebSocket subscription request fails.

pub async fn unsubscribe_mini_ticker_stream<K: AsRef<str>>( &mut self, id: i64, tickers: &[K], ) -> Result<(), Error>

Unsubscribes from the mini ticker stream for the specified symbol IDs.

This method sends an unsubscription request to the Binance WebSocket API for the specified symbol IDs. Each symbol ID is transformed into a mini ticker stream identifier before being sent.

Parameters

• id: A unique identifier for the subscription request.
• tickers: A slice of symbol IDs to subscribe to.

Errors

Returns a tungstenite::Error if the WebSocket unsubscription request fails.

pub async fn next(&mut self) -> Option<Result<Event, Error>>

Retrieves the next message from the WebSocket stream.

This method listens for incoming WebSocket messages and processes them. Supported message types include text messages (parsed as Event), ping messages, and close messages.

pub async fn close(&mut self) -> Result<(), Error>

Closes the WebSocket connection gracefully.

This method sends a close frame to the WebSocket server and waits for the connection to close.

Trait Implementations

impl AssetInfoProvider for WebSocketConnection

fn subscribe<'life0, 'life1, 'async_trait>( &'life0 mut self, ids: &'life1 [String], ) -> Pin<Box<dyn Future<Output = Result<(), Self::SubscriptionError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Subscribes to asset information updates for the given list of asset IDs.

This method sends a subscription request to the Binance WebSocket API for the specified asset IDs. Each asset ID is transformed into a mini ticker stream identifier before being sent.

Errors

Returns an error if the WebSocket subscription request fails.

fn next<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Option<Result<Data, Self::ListeningError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the next asset information update from the WebSocket stream.

This method listens for incoming WebSocket messages and processes them into Data instances. Supported message types include mini ticker updates and ping events.

Errors

Returns a ListeningError if:

• The WebSocket message cannot be parsed
• The mini ticker data contains invalid values

fn try_close<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait,

Attempts to close the WebSocket connection gracefully.

This method spawns a task to close the WebSocket connection asynchronously. It ensures that the connection is terminated without blocking the caller.

type SubscriptionError = Error

The type returned in the event of a subscription failure.

type ListeningError = ListeningError

The type returned in the event of a message reception failure.