Struct transmission::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();

Methods

impl Client

pub fn new(config: ClientConfig) -> Self

Creates a new Client and initializes the session.

Takes a ClientConfig with the populated options.

pub fn add_torrent_file(&mut self, path: &str) -> TrResult<Torrent>

Adds a torrent using a torrent file.

Takes the path to the torrent file on the disk.

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();

c.close();

pub fn add_torrent_magnet(&mut self, link: &str) -> TrResult<Torrent>

Adds a torrent using a magnet link.

Takes the magnet URI of the torrent.

use transmission::{ ClientConfig, Client};



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_magnet(magnet_uri).unwrap();

c.close();

pub fn close(&mut self)

Gracefully closes the client ending the session.

Always call this otherwise the client will panic! on drop in order to prevent issues.

Trait Implementations

impl Sync for Client

impl Send for Client

impl Drop for Client

fn drop(&mut self)

Executes the destructor for this type.