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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
use std::collections::HashMap;
use reqwest::multipart;
use crate::{
error::Error,
models::{BuildInfo, Cookie, DirMode, Preferences},
};
impl super::Api {
/// Get Qbittorrent application version
///
/// The response is a string with the application version, e.g. `v5.1.0`
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-application-version)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let version = client.version().await.unwrap();
///
/// println!("{}", version);
/// }
/// ```
pub async fn version(&self) -> Result<String, Error> {
let version = self
._get("app/version")
.await?
.send()
.await?
.error_for_status()?
.text()
.await?;
Ok(version)
}
/// Get WebAPI version
///
/// The response is a string with the WebAPI version, e.g. `2.11.4`
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-api-version)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let version = client.webapi_version().await.unwrap();
///
/// println!("{}", version);
/// }
/// ```
pub async fn webapi_version(&self) -> Result<String, Error> {
let version = self
._get("app/webapiVersion")
.await?
.send()
.await?
.error_for_status()?
.text()
.await?;
Ok(version)
}
/// Get build info
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-build-info)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let build = client.build_info().await.unwrap();
///
/// println!("{:#?}", build);
/// }
/// ```
pub async fn build_info(&self) -> Result<BuildInfo, Error> {
let build_info = self
._get("app/buildInfo")
.await?
.send()
.await?
.error_for_status()?
.json::<BuildInfo>()
.await?;
Ok(build_info)
}
/// Shutdown Qbittorent application
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#shutdown-application)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// client.shutdown().await.unwrap();
/// }
/// ```
pub async fn shutdown(&self) -> Result<(), Error> {
self._post("app/shutdown")
.await?
.send()
.await?
.error_for_status()?;
Ok(())
}
/// Get application preferences
///
/// Returns struct with several fields representing the application's settings.
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-application-preferences)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let preferences = client.preferences().await.unwrap();
///
/// println!("{:#?}", preferences);
/// }
/// ```
pub async fn preferences(&self) -> Result<Preferences, Error> {
let preferences = self
._get("app/preferences")
.await?
.send()
.await?
.error_for_status()?
.json::<Preferences>()
.await?;
Ok(preferences)
}
/// Set application preferences
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#set-application-preferences)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
/// use qbit::models::Preferences;
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let preferences = Preferences::default();
///
/// let resulte = client.set_preferences(preferences).await;
///
/// assert!(resulte.is_ok());
/// }
/// ```
pub async fn set_preferences(&self, preferences: Preferences) -> Result<(), Error> {
let form = multipart::Form::new().text("json", serde_json::to_string(&preferences)?);
self._post("app/setPreferences")
.await?
.multipart(form)
.send()
.await?
.error_for_status()?;
Ok(())
}
/// Get default save path
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-default-save-path)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let save_path = client.default_save_path().await.unwrap();
///
/// println!("{}", save_path);
/// }
/// ```
pub async fn default_save_path(&self) -> Result<String, Error> {
let preferences = self
._get("app/defaultSavePath")
.await?
.send()
.await?
.error_for_status()?
.text()
.await?;
Ok(preferences)
}
/// Get cookies
///
/// Retrieves cookies used for downloading .torrent files and RSS feeds.
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#get-cookies)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let cookies = client.cookies().await.unwrap();
///
/// for cookie in cookies {
/// println!("{:?}", cookie);
/// }
/// }
/// ```
pub async fn cookies(&self) -> Result<Vec<Cookie>, Error> {
let cookies = self
._get("app/cookies")
.await?
.send()
.await?
.error_for_status()?
.json::<Vec<Cookie>>()
.await?;
Ok(cookies)
}
/// Set cookies
///
/// Sets the cookies used for downloading .torrent files and RSS feeds.
///
/// This will overwrite all the cookies.
///
/// [official documentation](https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-5.0)#set-cookies)
///
/// # Arguments
///
/// * `cookies` - A list of cookies to be set.
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
/// use qbit::models::Cookie;
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let cookie = Cookie::default();
/// let result = client.set_cookies(vec![cookie]).await;
///
/// assert!(result.is_ok());
/// }
/// ```
pub async fn set_cookies(&self, cookies: Vec<Cookie>) -> Result<(), Error> {
let form = multipart::Form::new().text("cookies", serde_json::to_string(&cookies)?);
self._post("app/setCookies")
.await?
.multipart(form)
.send()
.await?
.error_for_status()?;
Ok(())
}
/// List the contents of the directory. (Yes this is an endpoint)
///
/// # Example
///
/// ```no_run
/// use qbit::{Api, Credentials};
/// use qbit::models::DirMode;
///
/// #[tokio::main]
/// async fn main() {
/// let credentials = Credentials::new("username", "password");
/// let client = Api::new_login("http://127.0.0.1/", credentials)
/// .await
/// .unwrap();
///
/// let contents = client.get_directory_contents("/path/to/some/file", &DirMode::All)
/// .await
/// .unwrap();
///
/// for item in contents {
/// println!("{}", item);
/// }
/// }
/// ```
pub async fn get_directory_contents(
&self,
dir: &str,
mode: &DirMode,
) -> Result<Vec<String>, Error> {
let mut form = HashMap::new();
form.insert("dirPath", dir.to_string());
form.insert("mode", mode.to_string());
Ok(self
._post("app/getDirectoryContent")
.await?
.form(&form)
.send()
.await?
.error_for_status()?
.json::<Vec<String>>()
.await?)
}
}