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 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
use std::fmt::{Debug, Display};
use reqwest::Url;
use serde::Serialize;
use serde_with::{skip_serializing_none, SerializeDisplay};
use crate::model::Sep;
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum TorrentFilter {
All,
Downloading,
Completed,
Paused,
Active,
Inactive,
Resumed,
Stalled,
StalledUploading,
StalledDownloading,
Errored,
}
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct Torrent {
/// Time (Unix Epoch) when the torrent was added to the client
pub added_on: Option<i64>,
/// Amount of data left to download (bytes)
pub amount_left: Option<i64>,
/// Whether this torrent is managed by Automatic Torrent Management
pub auto_tmm: Option<bool>,
/// Percentage of file pieces currently available
pub availability: Option<f64>,
/// Category of the torrent
pub category: Option<String>,
/// Amount of transfer data completed (bytes)
pub completed: Option<i64>,
/// Time (Unix Epoch) when the torrent completed
pub completion_on: Option<i64>,
/// Absolute path of torrent content (root path for multifile torrents,
/// absolute file path for singlefile torrents)
pub content_path: Option<String>,
/// Torrent download speed limit (bytes/s). `-1` if unlimited.
pub dl_limit: Option<i64>,
/// Torrent download speed (bytes/s)
pub dlspeed: Option<i64>,
/// Amount of data downloaded
pub downloaded: Option<i64>,
/// Amount of data downloaded this session
pub downloaded_session: Option<i64>,
/// Torrent ETA (seconds)
pub eta: Option<i64>,
/// True if first last piece are prioritized
pub f_l_piece_prio: Option<bool>,
/// True if force start is enabled for this torrent
pub force_start: Option<bool>,
/// Torrent hash
pub hash: Option<String>,
/// Last time (Unix Epoch) when a chunk was downloaded/uploaded
pub last_activity: Option<i64>,
/// Magnet URI corresponding to this torrent
pub magnet_uri: Option<String>,
/// Maximum share ratio until torrent is stopped from seeding/uploading
pub max_ratio: Option<f64>,
/// Maximum seeding time (seconds) until torrent is stopped from seeding
pub max_seeding_time: Option<i64>,
/// Torrent name
pub name: Option<String>,
/// Number of seeds in the swarm
pub num_complete: Option<i64>,
/// Number of leechers in the swarm
pub num_incomplete: Option<i64>,
/// Number of leechers connected to
pub num_leechs: Option<i64>,
/// Number of seeds connected to
pub num_seeds: Option<i64>,
/// Torrent priority. Returns -1 if queuing is disabled or torrent is in
/// seed mode
pub priority: Option<i64>,
/// Torrent progress (percentage/100)
pub progress: Option<f64>,
/// Torrent share ratio. Max ratio value: 9999.
pub ratio: Option<f64>,
pub ratio_limit: Option<f64>,
/// Path where this torrent's data is stored
pub save_path: Option<String>,
/// Torrent elapsed time while complete (seconds)
pub seeding_time: Option<i64>,
/// seeding_time_limit is a per torrent setting, when Automatic Torrent
/// Management is disabled, furthermore then max_seeding_time is set to
/// seeding_time_limit for this torrent. If Automatic Torrent Management
/// is enabled, the value is -2. And if max_seeding_time is unset it
/// have a default value -1.
pub seeding_time_limit: Option<i64>,
/// Time (Unix Epoch) when this torrent was last seen complete
pub seen_complete: Option<i64>,
/// True if sequential download is enabled
pub seq_dl: Option<bool>,
/// Total size (bytes) of files selected for download
pub size: Option<i64>,
/// Torrent state. See table here below for the possible values
pub state: Option<State>,
/// True if super seeding is enabled
pub super_seeding: Option<bool>,
/// Comma-concatenated tag list of the torrent
pub tags: Option<String>,
/// Total active time (seconds)
pub time_active: Option<i64>,
/// Total size (bytes) of all file in this torrent (including unselected
/// ones)
pub total_size: Option<i64>,
/// The first tracker with working status. Returns empty String if no
/// tracker is working.
pub tracker: Option<String>,
/// Torrent upload speed limit (bytes/s). `-1` if unlimited.
pub up_limit: Option<i64>,
/// Amount of data uploaded
pub uploaded: Option<i64>,
/// Amount of data uploaded this session
pub uploaded_session: Option<i64>,
/// Torrent upload speed (bytes/:,)
pub upspeed: Option<i64>,
}
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub enum State {
/// Some error occurred, applies to paused torrents
#[serde(rename = "error")]
Error,
/// Torrent data files is missing
#[serde(rename = "missingFiles")]
MissingFiles,
/// Torrent is being seeded and data is being transferred
#[serde(rename = "uploading")]
Uploading,
/// Torrent is paused and has finished downloading
#[serde(rename = "pausedUP")]
PausedUP,
/// Queuing is enabled and torrent is queued for upload
#[serde(rename = "queuedUP")]
QueuedUP,
/// Torrent is being seeded, but no connection were made
#[serde(rename = "stalledUP")]
StalledUP,
/// Torrent has finished downloading and is being checked
#[serde(rename = "checkingUP")]
CheckingUP,
/// Torrent is forced to uploading and ignore queue limit
#[serde(rename = "forcedUP")]
ForcedUP,
/// Torrent is allocating disk space for download
#[serde(rename = "allocating")]
Allocating,
/// Torrent is being downloaded and data is being transferred
#[serde(rename = "downloading")]
Downloading,
/// Torrent has just started downloading and is fetching metadata
#[serde(rename = "metaDL")]
MetaDL,
/// Torrent is paused and has NOT finished downloading
#[serde(rename = "pausedDL")]
PausedDL,
/// Queuing is enabled and torrent is queued for download
#[serde(rename = "queuedDL")]
QueuedDL,
/// Torrent is being downloaded, but no connection were made
#[serde(rename = "stalledDL")]
StalledDL,
/// Same as checkingUP, but torrent has NOT finished downloading
#[serde(rename = "checkingDL")]
CheckingDL,
/// Torrent is forced to downloading to ignore queue limit
#[serde(rename = "forcedDL")]
ForcedDL,
/// Checking resume data on qBt startup
#[serde(rename = "checkingResumeData")]
CheckingResumeData,
/// Torrent is moving to another location
#[serde(rename = "moving")]
Moving,
/// Unknown status
#[serde(rename = "unknown")]
Unknown,
}
#[derive(Debug, Clone, PartialEq, serde::Deserialize)]
pub struct TorrentProperty {
/// Torrent save path
pub save_path: Option<String>,
/// Torrent creation date (Unix timestamp)
pub creation_date: Option<i64>,
/// Torrent piece size (bytes)
pub piece_size: Option<i64>,
/// Torrent comment
pub comment: Option<String>,
/// Total data wasted for torrent (bytes)
pub total_wasted: Option<i64>,
/// Total data uploaded for torrent (bytes)
pub total_uploaded: Option<i64>,
/// Total data uploaded this session (bytes)
pub total_uploaded_session: Option<i64>,
/// Total data downloaded for torrent (bytes)
pub total_downloaded: Option<i64>,
/// Total data downloaded this session (bytes)
pub total_downloaded_session: Option<i64>,
/// Torrent upload limit (bytes/s)
pub up_limit: Option<i64>,
/// Torrent download limit (bytes/s)
pub dl_limit: Option<i64>,
/// Torrent elapsed time (seconds)
pub time_elapsed: Option<i64>,
/// Torrent elapsed time while complete (seconds)
pub seeding_time: Option<i64>,
/// Torrent connection count
pub nb_connections: Option<i64>,
/// Torrent connection count limit
pub nb_connections_limit: Option<i64>,
/// Torrent share ratio
pub share_ratio: Option<f64>,
/// When this torrent was added (unix timestamp)
pub addition_date: Option<i64>,
/// Torrent completion date (unix timestamp)
pub completion_date: Option<i64>,
/// Torrent creator
pub created_by: Option<String>,
/// Torrent average download speed (bytes/second)
pub dl_speed_avg: Option<i64>,
/// Torrent download speed (bytes/second)
pub dl_speed: Option<i64>,
/// Torrent ETA (seconds)
pub eta: Option<i64>,
/// Last seen complete date (unix timestamp)
pub last_seen: Option<i64>,
/// Number of peers connected to
pub peers: Option<i64>,
/// Number of peers in the swarm
pub peers_total: Option<i64>,
/// Number of pieces owned
pub pieces_have: Option<i64>,
/// Number of pieces of the torrent
pub pieces_num: Option<i64>,
/// Number of seconds until the next announce
pub reannounce: Option<i64>,
/// Number of seeds connected to
pub seeds: Option<i64>,
/// Number of seeds in the swarm
pub seeds_total: Option<i64>,
/// Torrent total size (bytes)
pub total_size: Option<i64>,
/// Torrent average upload speed (bytes/second)
pub up_speed_avg: Option<i64>,
/// Torrent upload speed (bytes/second)
pub up_speed: Option<i64>,
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct WebSeed {
/// Web seed URL
pub url: Url,
}
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
pub struct TorrentContent {
/// File index
pub index: u64,
/// File name (including relative path),
pub name: String,
/// File size (bytes),
pub size: u64,
/// File progress (percentage/100),
pub progress: f64,
/// File priority. See possible values here below,
pub priority: Priority,
/// True if file is seeding/complete,
pub is_seed: Option<bool>,
/// The first number is the starting piece index and the second number is
/// the ending piece index (inclusive),
#[serde(default)]
pub piece_range: Vec<u64>,
/// Percentage of file pieces currently available (percentage/100),
#[serde(default)]
pub availability: f64,
}
#[derive(
Debug,
Clone,
Copy,
PartialEq,
Eq,
PartialOrd,
Ord,
serde_repr::Serialize_repr,
serde_repr::Deserialize_repr,
)]
#[repr(u8)]
pub enum Priority {
/// Do not download
DoNotDownload = 0,
/// Normal priority
Normal = 1,
/// High priority
High = 6,
/// Maximal priority
Maximal = 7,
}
#[derive(
Debug,
Clone,
Copy,
PartialEq,
Eq,
PartialOrd,
Ord,
serde_repr::Serialize_repr,
serde_repr::Deserialize_repr,
)]
#[repr(u8)]
pub enum PieceState {
/// Not downloaded yet
NotDownloaded = 0,
/// Now downloading
Downloading = 1,
/// Already downloaded
Downloaded = 2,
}
/// `|` separeated list of hash values or `all`
#[derive(Debug, Clone, PartialEq, Eq, SerializeDisplay)]
pub enum Hashes {
/// A list of torrent hashes separated by `|`
Hashes(Sep<String, '|'>),
/// All torrents
All,
}
impl<V: Into<Vec<String>>> From<V> for Hashes {
fn from(hashes: V) -> Self {
Hashes::Hashes(Sep::from(hashes))
}
}
impl Display for Hashes {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Hashes::Hashes(hashes) => write!(f, "{}", hashes),
Hashes::All => write!(f, "all"),
}
}
}
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[cfg_attr(
feature = "builder",
builder(field_defaults(default, setter(strip_option)))
)]
#[derive(Debug, Clone, PartialEq, Default, serde::Serialize)]
#[skip_serializing_none]
pub struct GetTorrentListArg {
/// Filter torrent list by state. Allowed state filters: `all`,
/// `downloading`, `seeding`, `completed`, `paused`, `active`, `inactive`,
/// `resumed`, `stalled`, `stalled_uploading`, `stalled_downloading`,
/// `errored`
pub filter: Option<TorrentFilter>,
/// Get torrents with the given category (empty string means "without category"; no "category" parameter means "any category" <- broken until [#11748](https://github.com/qbittorrent/qBittorrent/issues/11748) is resolved). Remember to URL-encode the category name. For example, `My category` becomes `My%20category`
pub category: Option<String>,
/// Get torrents with the given tag (empty string means "without tag"; no
/// "tag" parameter means "any tag". Remember to URL-encode the category
/// name. For example, `My tag` becomes `My%20tag`
pub tag: Option<String>,
/// Sort torrents by given key. They can be sorted using any field of the
/// response's JSON array (which are documented below) as the sort key.
pub sort: Option<String>,
/// Enable reverse sorting. Defaults to `false`
pub reverse: Option<bool>,
/// Limit the number of torrents returned
pub limit: Option<u64>,
/// Set offset (if less than 0, offset from end)
pub offset: Option<i64>,
/// Filter by hashes. Can contain multiple hashes separated by `\|`
pub hashes: Option<String>,
}
#[derive(Debug, Clone, PartialEq, Eq, Serialize)]
#[serde(untagged)]
pub enum TorrentSource {
/// URLs
Urls { urls: Sep<Url, '\n'> },
/// Raw data of torrent file.
TorrentFiles { torrents: Vec<u8> },
}
impl Default for TorrentSource {
fn default() -> Self {
TorrentSource::Urls {
urls: Sep::from(vec![]),
}
}
}
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[cfg_attr(
feature = "builder",
builder(field_defaults(default, setter(strip_option)))
)]
#[derive(Debug, Clone, PartialEq, serde::Serialize, Default)]
#[skip_serializing_none]
pub struct AddTorrentArg {
#[serde(flatten)]
#[cfg_attr(feature = "builder", builder(!default, setter(!strip_option)))]
pub source: TorrentSource,
/// Download folder
pub savepath: Option<String>,
/// Cookie sent to download the .torrent file
pub cookie: Option<String>,
/// Category for the torrent
pub category: Option<String>,
/// Tags for the torrent, split by ','
pub tags: Option<String>,
/// Skip hash checking. Possible values are `true`, `false` (default)
pub skip_checking: Option<String>,
/// Add torrents in the paused state. Possible values are `true`, `false`
/// (default)
pub paused: Option<String>,
/// Create the root folder. Possible values are `true`, `false`, unset
/// (default)
pub root_folder: Option<String>,
/// Rename torrent
pub rename: Option<String>,
/// Set torrent upload speed limit. Unit in bytes/second
#[serde(rename = "upLimit")]
pub up_limit: Option<i64>,
/// Set torrent download speed limit. Unit in bytes/second
#[serde(rename = "dlLimit")]
pub download_limit: Option<i64>,
/// Set torrent share ratio limit
#[serde(rename = "ratioLimit")]
pub ratio_limit: Option<f64>,
/// Set torrent seeding time limit. Unit in minutes
#[serde(rename = "seedingTimeLimit")]
pub seeding_time_limit: Option<i64>,
/// Whether Automatic Torrent Management should be used
#[serde(rename = "autoTMM")]
pub auto_torrent_management: Option<bool>,
/// Enable sequential download. Possible values are `true`, `false`
/// (default)
#[serde(rename = "sequentialDownload")]
pub sequential_download: Option<String>,
/// Prioritize download first last piece. Possible values are `true`,
/// `false` (default)
#[serde(rename = "firstLastPiecePrio")]
pub first_last_piece_priority: Option<String>,
}
#[cfg_attr(feature = "builder", derive(typed_builder::TypedBuilder))]
#[derive(Debug, Clone, PartialEq, serde::Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SetTorrentSharedLimitArg {
#[cfg_attr(feature = "builder", builder(setter(into)))]
pub hashes: Hashes,
#[cfg_attr(feature = "builder", builder(default, setter(strip_option)))]
pub ratio_limit: Option<RatioLimit>,
#[cfg_attr(feature = "builder", builder(default, setter(strip_option)))]
pub seeding_time_limit: Option<SeedingTimeLimit>,
}
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub enum RatioLimit {
Global,
NoLimit,
Limited(f64),
}
impl Serialize for RatioLimit {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
match self {
Self::Global => serializer.serialize_i64(-2),
Self::NoLimit => serializer.serialize_i64(-1),
Self::Limited(limit) => serializer.serialize_f64(*limit),
}
}
}
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
pub enum SeedingTimeLimit {
Global,
NoLimit,
/// Number of minutes
Limited(u64),
}
impl Serialize for SeedingTimeLimit {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
match self {
Self::Global => serializer.serialize_i64(-2),
Self::NoLimit => serializer.serialize_i64(-1),
Self::Limited(limit) => serializer.serialize_u64(*limit),
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub(crate) struct HashArg<'a> {
hash: &'a str,
}
impl<'a> HashArg<'a> {
pub(crate) fn new(hash: &'a str) -> Self {
Self { hash }
}
}
#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub(crate) struct HashesArg {
hashes: Hashes,
}
impl HashesArg {
pub(crate) fn new(hashes: impl Into<Hashes> + Send + Sync) -> Self {
Self {
hashes: hashes.into(),
}
}
}