qbittorrent_rust/
lib.rs

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
//! # Qbittorrent-rust
//! 
//! Qbittorrent-rust is an asynchronous library that makes interfacing with the Qbittorrent WebUI API simple and intuitive, 
//! keeping things as simple as possible while still letting you have maximum freedom of use.
//! 
//! ## Design
//! 
//! The library is designed to have as few obscuring types as possible between your code and the Qbittorrent API on purpose, 
//! and its philosophy is to give the user the most freedom possible while working with it.
//! 
//! ## Usage
//! 
//! The library's main structure is [`QbitApi`], which provides all the methods to the Qbittorrent WebUI API.
//! There are 7 categories of methods, corresponding to the the various categories of requests in the Qbittorrent WebUI API documentation:
//!
//! | Name | Use |
//! | ------ | ------ |
//! | torrents | holds everything related to torrents. |
//! | log |  holds everything related to logging. |
//! | app |  holds everything related to the WebUI API application. |
//! | transfer |  holds everything related to transfer information. |
//! | sync |  holds everything related to synchronization. |
//! | search |  holds everything related to searching ans searching plugins. |
//! | rss |  holds everything related to RSS. |
//!
//! each method in [`QbitApi`] starts with its category, followed by the method's name, all in snake case. example: `torrents_add_torrent`


pub mod core;
pub mod misc;
pub mod error_handling;
pub mod api_fns;
pub mod macros;

pub use error_handling::errors::Error;
pub use api_fns::application::app_preferences::*;
pub use api_fns::log::logs::*;
pub use api_fns::rss::rss::*;
pub use api_fns::search::search::*;
pub use api_fns::torrents::{add_torrent::*, info::*, torrent_managing_misc::*, torrents::*};