Struct WebSocketConnection 

pub struct WebSocketConnection { /* private fields */ }

A connection to the Coinbase WebSocket API.

Implementations

impl WebSocketConnection

Represents a WebSocket connection to the Coinbase API. This struct provides methods for subscribing and unsubscribing to channels, receiving messages, and closing the connection.

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

Creates a new CoinbaseWebSocketConnection.

pub async fn subscribe<T: AsRef<str>>( &mut self, channels: Vec<Channel>, product_ids: &[T], ) -> Result<(), Error>

Subscribes to the specified channels and product IDs.

This method sends a subscription request to the WebSocket server for the specified channels and product IDs.

Parameters

• channels: A vector of channels to subscribe to.
• product_ids: A slice of product IDs to subscribe to.

Returns

Returns a Result indicating success or failure of the subscription request.

Errors

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

pub async fn unsubscribe<T: AsRef<str>>( &mut self, channels: Vec<Channel>, product_ids: &[T], ) -> Result<(), Error>

Unsubscribes from the specified channels and product IDs.

This method sends an unsubscription request to the WebSocket server for the specified channels and product IDs.

Parameters

• channels: A vector of channels to unsubscribe from.
• product_ids: A slice of product IDs to unsubscribe from.

Returns

Returns a Result indicating success or failure of the unsubscription request.

Errors

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

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

Receives the next message from the WebSocket.

This method listens for incoming messages from the WebSocket stream and processes them. It handles different message types, including text messages, ping messages, and close messages.

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

Closes the WebSocket connection.

This method sends a close message 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 the given list of asset IDs.

This method sends a subscription request to the WebSocket server for the specified asset IDs.

Parameters

• ids: A slice of asset IDs to subscribe to.

Returns

Returns a Result indicating success or failure of the subscription request.

Errors

If the WebSocket connection fails to send the subscription message, it returns a tungstenite::Error.

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,

Receives the next asset info update from the WebSocket connection.

This method listens for incoming messages from the WebSocket stream and processes them. It handles different message types, including ticker updates, ping messages, and error messages.

Returns

Returns an Option containing a Result with the parsed Data or an error.

Errors

If the message cannot be parsed or if there is an error in processing the ticker data,

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

where Self: 'async_trait,

Attempts to close the WebSocket connection.

This method spawns a task to close the WebSocket connection asynchronously.

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.