Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

Represents an active WebSocket connection to Bybit.

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

Implementations

impl WebSocketConnection

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

Creates a new BybitWebSocketConnection.

pub async fn subscribe_ticker<T: AsRef<str>>( &mut self, symbols: &[T], ) -> Result<(), Error>

Subscribes to the ticker stream for the specified symbol IDs.

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

Parameters

• symbols: A slice of symbol IDs to subscribe to.

Errors

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

pub async fn unsubscribe_ticker<T: AsRef<str>>( &mut self, symbols: &[T], ) -> Result<(), Error>

Unsubscribes from the ticker stream for the specified symbol IDs.

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

Parameters

• symbols: A slice of symbol IDs to unsubscribe from.

Errors

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

pub async fn next(&mut self) -> Option<Result<Response, 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 Response), 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

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.

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 updates for the specified asset IDs.

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,

Waits for and returns the next data update from the WebSocket.

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

where Self: 'async_trait,

Attempts to gracefully close the WebSocket connection.