Struct WebSocketConnector 

pub struct WebSocketConnector { /* private fields */ }

A connector for establishing WebSocket connections to the HTX WebSocket API.

The WebSocketConnector provides methods to create a new connector and connect to the WebSocket server. It handles the initial connection setup and returns a WebSocketConnection for further operations.

Examples

use bothan_htx::api::websocket::WebSocketConnector;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let connector = WebSocketConnector::new("wss://api.huobi.pro/ws");
    let connection = connector.connect().await?;
    Ok(())
}

Implementations

impl WebSocketConnector

pub fn new(url: impl Into<String>) -> Self

Creates a new instance of WebSocketConnector with the given URL.

Parameters

• url: The WebSocket URL for the HTX API

Returns

A new WebSocketConnector instance with the specified URL.

Examples

use bothan_htx::api::websocket::WebSocketConnector;

let connector = WebSocketConnector::new("wss://api.huobi.pro/ws");

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

Connects to the HTX WebSocket API.

This method establishes a WebSocket connection to the HTX server and returns a WebSocketConnection instance for further operations.

Returns

Returns a Result containing a WebSocketConnection on success, or a tungstenite::Error if the connection fails.

Examples

use bothan_htx::api::websocket::WebSocketConnector;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let connector = WebSocketConnector::new("wss://api.huobi.pro/ws");
    let connection = connector.connect().await?;
    Ok(())
}

Errors

Returns a tungstenite::Error if:

• The WebSocket connection cannot be established
• The URL is invalid
• Network connectivity issues occur

Trait Implementations

impl AssetInfoProviderConnector for WebSocketConnector

fn connect<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<WebSocketConnection, Self::Error>> + Send + 'async_trait>>

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

Connects to the HTX WebSocket API and returns a WebSocketConnection.

This method is part of the AssetInfoProviderConnector trait implementation, providing a standardized way to establish WebSocket connections for asset workers.

type Provider = WebSocketConnection

The type of provider that this connector creates.

type Error = Error

The type returned in the event of a connection failure.