qbittorrent_rust/lib.rs
1//! # Qbittorrent-rust
2//!
3//! Qbittorrent-rust is an asynchronous library that makes interfacing with the Qbittorrent WebUI API simple and intuitive,
4//! keeping things as simple as possible while still letting you have maximum freedom of use.
5//!
6//! ## Design
7//!
8//! The library is designed to have as few obscuring types as possible between your code and the Qbittorrent API on purpose,
9//! and its philosophy is to give the user the most freedom possible while working with it.
10//!
11//! ## Usage
12//!
13//! The library's main structure is [`QbitApi`], which provides all the methods to the Qbittorrent WebUI API.
14//! There are 7 categories of methods, corresponding to the the various categories of requests in the Qbittorrent WebUI API documentation:
15//!
16//! | Name | Use |
17//! | ------ | ------ |
18//! | torrents | holds everything related to torrents. |
19//! | log | holds everything related to logging. |
20//! | app | holds everything related to the WebUI API application. |
21//! | transfer | holds everything related to transfer information. |
22//! | sync | holds everything related to synchronization. |
23//! | search | holds everything related to searching ans searching plugins. |
24//! | rss | holds everything related to RSS. |
25//!
26//! each method in [`QbitApi`] starts with its category, followed by the method's name, all in snake case. example: `torrents_add_torrent`
27
28
29pub mod core;
30pub mod misc;
31pub mod error_handling;
32pub mod api_fns;
33pub mod macros;
34
35pub use error_handling::errors::Error;
36pub use api_fns::application::app_preferences::*;
37pub use api_fns::log::logs::*;
38pub use api_fns::rss::rss::*;
39pub use api_fns::search::search::*;
40pub use api_fns::torrents::{add_torrent::*, info::*, torrent_managing_misc::*, torrents::*};