binance-sdk 45.0.0

This is a lightweight library that works as a connector to the Binance public API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

/*
 * Binance Derivatives Trading USDS Futures WebSocket API
 *
 * OpenAPI Specification for the Binance Derivatives Trading USDS Futures WebSocket API
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

use crate::{common::config::ConfigurationWebsocketApi, models::WebsocketApiConnectConfig};

use super::WebsocketApi;

#[derive(Clone)]
pub struct WebsocketApiHandle {
    configuration: ConfigurationWebsocketApi,
}

impl WebsocketApiHandle {
    pub fn new(configuration: ConfigurationWebsocketApi) -> Self {
        Self { configuration }
    }

    /// Connects to the WebSocket API using default configuration.
    ///
    /// # Returns
    ///
    /// A `Result` containing the connected `WebsocketApi` instance if successful,
    /// or an error if the connection fails.
    ///
    /// # Errors
    ///
    /// Returns an [`anyhow::Error`] if the connection fails.
    ///
    pub async fn connect(&self) -> anyhow::Result<WebsocketApi> {
        self.connect_with_config(Default::default()).await
    }

    /// Connects to the WebSocket API with a custom configuration.
    ///
    /// # Arguments
    ///
    /// * `cfg` - A configuration object specifying connection parameters.
    ///
    /// # Returns
    ///
    /// A `Result` containing the connected `WebsocketApi` instance if successful,
    /// or an error if the connection fails.
    ///
    /// # Errors
    ///
    /// Returns an [`anyhow::Error`] if the connection fails.
    ///
    pub async fn connect_with_config(
        &self,
        cfg: WebsocketApiConnectConfig,
    ) -> anyhow::Result<WebsocketApi> {
        WebsocketApi::connect(self.configuration.clone(), cfg.mode).await
    }
}