Struct transmission_rs::client::Client

pub struct Client { /* fields omitted */ }

Interface into the major functions of Transmission including adding, and removing torrents.

The Client does not keep track of the created torrents itself.

Example of creating a session and adding a torrent and waiting for it to complete.

use transmission::{ ClientConfig, Client};

let file_path = "./alpine.torrent";


let c = ClientConfig::new()
   .app_name("testing")
   .config_dir(config_dir)
   .download_dir(download_dir);
let mut c = Client::new(c);

let t = c.add_torrent_file(file_path).unwrap();
t.start();

// Run until done
while t.stats().percent_complete < 1.0 {
    print!("{:#?}\r", t.stats().percent_complete);
}
c.close();

Implementations

impl Client

pub fn new(
    host: impl ToString,
    port: u16,
    tls: bool,
    auth: Option<(String, String)>
) -> Result<Self, Box<dyn Error>>

pub async fn authenticate<'_>(&'_ mut self) -> Result<(), Box<dyn Error>>

pub fn post(&self, path: impl AsRef<str>) -> RequestBuilder

pub async fn rpc<'_>(
    &'_ self,
    method: impl ToString,
    tag: u8,
    body: impl Serialize
) -> Result<Response, Box<dyn Error>>

pub async fn list<'_>(&'_ self) -> Result<Vec<Torrent>, Box<dyn Error>>

pub async fn add_torrent_from_link<'_>(
    &'_ self,
    url: impl ToString
) -> Result<AddTorrentResponse, Box<dyn Error>>

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.