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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
//! Structs returned by api queries use serde::{Deserialize, Serialize}; use super::utils; use derive_getters::Getters; /// Overall metadata about this qbit client // TODO: fix struct definitions #[derive(Debug, Deserialize, Getters)] pub struct MainData { rid: u64, full_update: bool, torrents: Torrent, torrents_removed: Vec<String>, categories: Categories, categories_removed: Vec<String>, tags: Vec<String>, tags_removed: Vec<String>, queueing: bool, server_state: ServerState, } /// generic torrent information returned from get_all_torrents() /// /// added_on integer Time (Unix Epoch) when the torrent was added to the client /// amount_left integer Amount of data left to download (bytes) /// auto_tmm bool Whether this torrent is managed by Automatic Torrent Management /// category string Category of the torrent /// completed integer Amount of transfer data completed (bytes) /// completion_on integer Time (Unix Epoch) when the torrent completed /// dl_limit integer Torrent download speed limit (bytes/s). -1 if ulimited. /// dlspeed integer Torrent download speed (bytes/s) /// downloaded integer Amount of data downloaded /// downloaded_session integer Amount of data downloaded this session /// eta integer Torrent ETA (seconds) /// f_l_piece_prio bool True if first last piece are prioritized /// force_start bool True if force start is enabled for this torrent /// hash string Torrent hash /// last_activity integer Last time (Unix Epoch) when a chunk was downloaded/uploaded /// magnet_uri string Magnet URI corresponding to this torrent /// max_ratio float Maximum share ratio until torrent is stopped from seeding/uploading /// max_seeding_time integer Maximum seeding time (seconds) until torrent is stopped from seeding /// name string Torrent name /// num_complete integer Number of seeds in the swarm /// num_incomplete integer Number of leechers in the swarm /// num_leechs integer Number of leechers connected to /// num_seeds integer Number of seeds connected to /// priority integer Torrent priority. Returns -1 if queuing is disabled or torrent is in seed mode /// progress float Torrent progress (percentage/100) /// ratio float Torrent share ratio. Max ratio value: 9999. /// ratio_limit float TODO (what is different from max_ratio?) /// save_path string Path where this torrent's data is stored /// seeding_time_limit integer TODO (what is different from max_seeding_time?) /// seen_complete integer Time (Unix Epoch) when this torrent was last seen complete /// seq_dl bool True if sequential download is enabled /// size integer Total size (bytes) of files selected for download /// state string Torrent state. See table here below for the possible values /// super_seeding bool True if super seeding is enabled /// tags string Comma-concatenated tag list of the torrent /// time_active integer Total active time (seconds) /// total_size integer Total size (bytes) of all file in this torrent (including unselected ones) /// tracker string The first tracker with working status. (TODO: what is returned if no tracker is working?) /// up_limit integer Torrent upload speed limit (bytes/s). -1 if ulimited. /// uploaded integer Amount of data uploaded /// uploaded_session integer Amount of data uploaded this session /// upspeed integer Torrent upload speed (bytes/s) #[derive(Debug, Deserialize, Getters, Clone)] pub struct Torrent { added_on: u32, amount_left: u64, auto_tmm: bool, category: String, completed: i64, completion_on: u32, dl_limit: i64, dlspeed: i64, downloaded: i64, downloaded_session: i64, eta: i64, // will sometimes error if this is not option f_l_piece_prio: Option<bool>, force_start: bool, pub(crate) hash: Hash, last_activity: u64, magnet_uri: String, max_ratio: f64, max_seeding_time: i64, name: String, num_complete: i64, num_incomplete: i64, num_leechs: i64, num_seeds: i64, priority: i64, progress: f64, ratio: f64, ratio_limit: f64, save_path: String, seeding_time_limit: i64, seen_complete: i64, seq_dl: bool, size: i64, state: State, super_seeding: bool, tags: String, time_active: i64, total_size: i64, tracker: String, up_limit: i64, uploaded: i64, uploaded_session: i64, upspeed: i64, } /// Trackers associated with a torrent /// /// url string Tracker url /// status integer Tracker status. See the table below for possible values /// tier integer Tracker priority tier. Lower tier trackers are tried before higher tiers /// num_peers integer Number of peers for current torrent, as reported by the tracker /// num_seeds integer Number of seeds for current torrent, asreported by the tracker /// num_leeches integer Number of leeches for current torrent, as reported by the tracker /// num_downloaded integer Number of completed downlods for current torrent, as reported by the tracker /// msg string Tracker message (there is no way of knowing what this message is - it's up to tracker admins) #[derive(Serialize, Deserialize, Debug, Clone, Getters)] pub struct Tracker { url: String, #[getter(skip)] status: String, // TODO: fix this since some people do things non standard with "/" here // tier: u32, num_peers: i32, // TODO: documentation says these will be returned but the fields do not appear // num_seeds: i32, // num_leeches: i32, // num_downloaded: i64, msg: String, } impl Tracker { // pub fn status(&self) -> TrackerStatus { // match self.status { // 0 => TrackerStatus::TrackerDisabled, // 1 => TrackerStatus::NotContacted, // 2 => TrackerStatus::Working, // 3 => TrackerStatus::Updating, // 4 => TrackerStatus::NotWorking, // _ => TrackerStatus::UnknownResponse, // } // } } /// Working-status tracker for a particular torrent #[derive(Serialize, Deserialize, Debug, Clone)] pub enum TrackerStatus { TrackerDisabled, NotContacted, Working, Updating, NotWorking, UnknownResponse, } /// Metadata about a torrent. returned from Torrent::properties() /// /// save_path string Torrent save path /// creation_date integer Torrent creation date (Unix timestamp) /// piece_size integer Torrent piece size (bytes) /// comment string Torrent comment /// total_wasted integer Total data wasted for torrent (bytes) /// total_uploaded integer Total data uploaded for torrent (bytes) /// total_uploaded_session integer Total data uploaded this session (bytes) /// total_downloaded integer Total data uploaded for torrent (bytes) /// total_downloaded_session integer Total data downloaded this session (bytes) /// up_limit integer Torrent upload limit (bytes/s) /// dl_limit integer Torrent download limit (bytes/s) /// time_elapsed integer Torrent elapsed time (seconds) /// seeding_time integer Torrent elapsed time while complete (seconds) /// nb_connections integer Torrent connection count /// nb_connections_limit integer Torrent connection count limit /// share_ratio float Torrent share ratio /// addition_date API4 integer When this torrent was added (unix timestamp) /// completion_date API4 integer Torrent completion date (unix timestamp) /// created_by API4 string Torrent creator /// dl_speed_avg API4 integer Torrent average download speed (bytes/second) /// dl_speed API4 integer Torrent download speed (bytes/second) /// eta API4 integer Torrent ETA (seconds) /// last_seen API4 integer Last seen complete date (unix timestamp) /// peers API4 integer Number of peers connected to /// peers_total API4 integer Number of peers in the swarm /// pieces_have API4 integer Number of pieces owned /// pieces_num API4 integer Number of pieces of the torrent /// reannounce API4 integer Number of seconds until the next announce /// seeds API4 integer Number of seeds connected to /// seeds_total API4 integer Number of seeds in the swarm /// total_size API4 integer Torrent total size (bytes) /// up_speed_avg API4 integer Torrent average upload speed (bytes/second) /// up_speed API4 integer Torrent upload speed (bytes/second) #[derive(Clone, Debug, Deserialize, Serialize, Getters)] pub struct TorrentProperties { save_path: String, creation_date: u32, piece_size: i64, comment: String, total_wasted: i64, total_uploaded: i64, total_uploaded_session: i64, total_downloaded: i64, total_downloaded_session: i64, up_limit: i64, dl_limit: i64, time_elapsed: i64, seeding_time: i64, nb_connections: i64, nb_connections_limit: i64, share_ratio: f64, addition_date: i64, completion_date: i64, created_by: String, dl_speed_avg: i64, dl_speed: i64, eta: i64, last_seen: i64, peers: i64, peers_total: i64, pieces_have: u64, pieces_num: i64, reannounce: i64, seeds: i64, seeds_total: i64, total_size: u64, up_speed_avg: i64, up_speed: i64, } /// Current status of a torrent (downloading, errored, puased, etc) /// /// error Some error occurred, applies to paused torrents /// missingFiles Torrent data files is missing /// uploading Torrent is being seeded and data is being transferred /// pausedUP Torrent is paused and has finished downloading /// queuedUP Queuing is enabled and torrent is queued for upload /// stalledUP Torrent is being seeded, but no connection were made /// checkingUP Torrent has finished downloading and is being checked /// forcedUP Torrent is forced to uploading and ignore queue limit /// allocating Torrent is allocating disk space for download /// downloading Torrent is being downloaded and data is being transferred /// metaDL Torrent has just started downloading and is fetching metadata /// pausedDL Torrent is paused and has NOT finished downloading /// queuedDL Queuing is enabled and torrent is queued for download /// stalledDL Torrent is being downloaded, but no connection were made /// checkingDL Same as checkingUP, but torrent has NOT finished downloading /// forceDL Torrent is forced to downloading to ignore queue limit /// checkingResumeData Checking resume data on qBt startup /// moving Torrent is moving to another location /// unknown Unknown status #[derive(Debug, Deserialize, Clone)] pub enum State { #[serde(rename = "error")] Error, #[serde(rename = "missingFiles")] MissingFiles, #[serde(rename = "uploading")] Uploading, #[serde(rename = "pausedUP")] PausedUP, #[serde(rename = "queuedUP")] QueuedUP, #[serde(rename = "stalledUP")] StalledUP, #[serde(rename = "checkingUP")] CheckingUP, #[serde(rename = "forcedUP")] ForcedUP, #[serde(rename = "allocating")] Allocating, #[serde(rename = "downloading")] Downloading, #[serde(rename = "metaDL")] MetaDL, #[serde(rename = "pausedDL")] PausedDL, #[serde(rename = "queuedDL")] QueuedDL, #[serde(rename = "stalledDL")] StalledDL, #[serde(rename = "checkingDL")] CheckingDL, #[serde(rename = "forcedDL")] ForceDL, #[serde(rename = "checkingResumeData")] CheckingResumeData, #[serde(rename = "moving")] Moving, #[serde(rename = "unkown")] Unknown, } /// Transfer stats for a torrent /// /// dl_info_speed integer Global download rate (bytes/s) /// dl_info_data integer Data downloaded this session (bytes) /// up_info_speed integer Global upload rate (bytes/s) /// up_info_data integer Data uploaded this session (bytes) /// dl_rate_limit integer Download rate limit (bytes/s) /// up_rate_limit integer Upload rate limit (bytes/s) /// dht_nodes integer DHT nodes connected to /// connection_status string Connection status. See possible values here below #[derive(Debug, Deserialize, Getters)] pub struct TransferInfo { dl_info_speed: u64, dl_info_data: u64, up_info_speed: u64, up_info_data: u64, dl_rate_limit: u64, up_rate_limit: u64, dht_nodes: u64, connection_status: ConnectionStatus, } /// Individual torrent connection status /// /// Possible values of connection_status: /// Value /// connected /// firewalled /// disconnected #[derive(Debug, Deserialize)] pub enum ConnectionStatus { Connected, Firewalled, Disconnected, } /// top-level torrent information /// /// name string File name (including relative path) /// size integer File size (bytes) /// progress float File progress (percentage/100) /// priority integer File priority. See possible values here below /// is_seed bool True if file is seeding/complete /// piece_range integer array The first number is the starting piece index and the second number is the ending piece index (inclusive) /// availability float Percentage of file pieces currently available #[derive(Debug, Deserialize, Serialize)] pub(crate) struct TorrentInfoSerde { name: String, size: i64, progress: f64, priority: i16, is_seed: Option<bool>, piece_range: Vec<i64>, availability: f64, } impl<'a> TorrentInfoSerde { pub fn into_info(self, hash: &'a Hash) -> TorrentInfo<'a> { TorrentInfo { hash, name: self.name, size: self.size, progress: self.progress, priority: self.priority, is_seed: self.is_seed, piece_range: self.piece_range, availability: self.availability, } } } #[derive(Debug, Serialize, Getters)] pub struct TorrentInfo<'a> { hash: &'a Hash, name: String, size: i64, progress: f64, priority: i16, is_seed: Option<bool>, piece_range: Vec<i64>, availability: f64, } #[derive(Debug, Deserialize)] pub struct Categories {} #[derive(Debug, Deserialize)] pub struct ServerState {} #[derive(Debug, Deserialize)] pub struct Peer {} #[derive(Debug, Deserialize)] pub struct BuildInfo { qt: String, libtorrent: String, boost: String, openssl: String, bitness: String, } #[derive(Deserialize, Debug)] pub struct Preferences {} #[derive(Deserialize, Debug)] pub struct Log { id: u64, message: String, timestamp: u64, r#type: u64, } #[derive(Deserialize, Serialize, Debug, Clone, Default)] #[serde(transparent)] pub struct Hash { pub(crate) hash: String, } impl From<String> for Hash { fn from(f: String) -> Self { Hash { hash: f } } } impl std::ops::Deref for Hash { type Target = String; fn deref(&self) -> &Self::Target { &self.hash } } #[derive(Debug, Serialize, Clone)] pub(crate) struct SerdeHashes<T: Serialize> { pub(crate) hashes: T, } impl<'a> From<&'a Hash> for SerdeHashes<&'a String> { fn from(e: &'a Hash) -> Self { SerdeHashes { hashes: e } } } impl<'a> From<&'a Vec<Hash>> for SerdeHashes<String> { fn from(hashes: &'a Vec<Hash>) -> Self { Self { hashes: utils::QueryConcat::query_concat(&hashes.as_slice(), '|'), } } }