rsbit 0.5.4

This is a library for the Bybit API.
Documentation 
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

pub mod get;
pub mod post;
mod request;

use crate::constants::{
    TESTNET_API_URL,
    MAINNET_API_URL,
    DEFAULT_RECV_WINDOW,
};

#[derive(Debug, Clone)]
pub struct BybitApi {
    base_url: &'static str,
    api_key: Option<String>,
    api_secret: Option<String>,
    recv_window: String,
}

impl BybitApi {
    /// Gets the base URL.
    ///
    /// # Returns
    ///
    /// The base URL.
    pub fn base_url(&self) -> &'static str {
        self.base_url
    }

    /// Gets the API key.
    ///
    /// # Returns
    ///
    /// The API key.
    pub fn api_key(&self) -> Option<&String> {
        self.api_key.as_ref()
    }

    /// Gets the API secret.
    ///
    /// # Returns
    ///
    /// The API secret.
    pub fn api_secret(&self) -> Option<&String> {
        self.api_secret.as_ref()
    }

    /// Gets the receive window.
    ///
    /// # Returns
    ///
    /// The receive window.
    pub fn recv_window(&self) -> &String {
        &self.recv_window
    }

    /// Create a new instance of the API.
    ///
    /// This method initializes a new instance of the API struct with default values.
    /// It returns the newly created instance.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Sets the API key.
    ///
    /// # Arguments
    ///
    /// * `api_key` - The API key to be set.
    ///
    /// # Returns
    ///
    /// The modified `Self` object.
    pub fn with_api_key(mut self, api_key: String) -> Self {
        self.api_key = Some(api_key);
        self
    }

    /// Sets the API secret.
    ///
    /// # Arguments
    ///
    /// * `api_secret` - The API secret to be set.
    ///
    /// # Returns
    ///
    /// The modified `Self` object.
    pub fn with_api_secret(mut self, api_secret: String) -> Self {
        self.api_secret = Some(api_secret);
        self
    }

    /// Sets the receive window.
    ///
    /// # Arguments
    ///
    /// * `recv_window` - The receive window to be set.
    ///
    /// # Returns
    ///
    /// The modified `Self` object.
    pub fn with_recv_window(mut self, recv_window: String) -> Self {
        self.recv_window = recv_window;
        self
    }

    /// Sets the base URL to the testnet API URL.
    ///
    /// # Returns
    ///
    /// The modified `Self` object.
    pub fn with_testnet(mut self) -> Self {
        self.base_url = TESTNET_API_URL;
        self
    }

    /// Sets the base URL to the mainnet API URL.
    ///
    /// # Returns
    ///
    /// The modified `Self` object.
    pub fn with_mainnet(mut self) -> Self {
        self.base_url = MAINNET_API_URL;
        self
    }
}

impl Default for BybitApi {
    fn default() -> Self {
        Self {
            base_url: TESTNET_API_URL,
            api_key: None,
            api_secret: None,
            recv_window: DEFAULT_RECV_WINDOW.to_string(),
        }
    }
}