Struct Api

pub struct Api { /* private fields */ }

Main handle and access point to working with qbittorrent

Full documentation on provided methods is available here here

Implementations

impl Api

pub async fn new( username: &str, password: &str, address: &str, ) -> Result<Self, Error>

pub async fn application_version(&self) -> Result<String, Error>

pub async fn api_version(&self) -> Result<String, Error>

pub async fn build_info(&self) -> Result<BuildInfo, Error>

pub async fn shutdown(&self) -> Result<(), Error>

pub async fn default_save_path(&self) -> Result<String, Error>

pub async fn get_log(&self, log_request: &LogRequest) -> Result<Vec<Log>, Error>

pub async fn get_global_transfer_info( &self, ) -> Result<GlobalTransferInfo, Error>

pub async fn get_alternate_speed_limits_state( &self, ) -> Result<AlternateLimits, Error>

pub async fn toggle_alternative_speed_limits(&self) -> Result<(), Error>

pub async fn get_torrent_list(&self) -> Result<Vec<Torrent>, Error>

pub async fn add_new_torrent(&self, data: &TorrentDownload) -> Result<(), Error>

pub async fn get_all_categories( &self, ) -> Result<BTreeMap<String, Categories>, Error>

list all categories that currently exist

pub async fn add_category(&self, name: &str, path: &str) -> Result<(), Error>

Trait Implementations

impl Category<Api> for Torrent

fn set_category<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, api: &'life1 Api, category: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

impl Debug for Api

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Pause<Api> for Hash

fn pause<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Pause<Api> for Torrent

fn pause<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Pause<Api> for Vec<Hash>

fn pause<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Recheck<Api> for Hash

fn recheck<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Recheck<Api> for Torrent

fn recheck<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Resume<Api> for Hash

fn resume<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Resume<Api> for Torrent

fn resume<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Resume<Api> for Vec<Hash>

fn resume<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

impl Tags<Api, [String]> for Hash

fn add_tag<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, api: &'life1 Api, tags: &'life2 [String], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

impl Tags<Api, [String]> for Torrent

fn add_tag<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, api: &'life1 Api, tags: &'life2 [String], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

impl TorrentData<Api> for Hash

fn properties<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<TorrentProperties, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn trackers<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<Vec<Tracker>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn contents<'a, 'async_trait>( &'a self, api: &'a Api, ) -> Pin<Box<dyn Future<Output = Result<Vec<TorrentInfo<'a>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

impl TorrentData<Api> for Torrent

fn properties<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<TorrentProperties, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn trackers<'life0, 'life1, 'async_trait>( &'life0 self, api: &'life1 Api, ) -> Pin<Box<dyn Future<Output = Result<Vec<Tracker>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn contents<'a, 'async_trait>( &'a self, api: &'a Api, ) -> Pin<Box<dyn Future<Output = Result<Vec<TorrentInfo<'a>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,

impl TorrentData<Torrent> for Api

fn properties<'life0, 'life1, 'async_trait>( &'life0 self, torrent: &'life1 Torrent, ) -> Pin<Box<dyn Future<Output = Result<TorrentProperties, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn trackers<'life0, 'life1, 'async_trait>( &'life0 self, torrent: &'life1 Torrent, ) -> Pin<Box<dyn Future<Output = Result<Vec<Tracker>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

fn contents<'a, 'async_trait>( &'a self, torrent: &'a Torrent, ) -> Pin<Box<dyn Future<Output = Result<Vec<TorrentInfo<'a>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'a: 'async_trait,