Struct transmission::torrent::torrent::Torrent

pub struct Torrent { /* fields omitted */ }

Representation of a torrent download.

Can be used to start, stop, or get the information of a torrent.

Methods

impl<'a> Torrent

pub fn parse_torrent_file(path: &str) -> TrResult<TorrentInfo>

pub fn build() -> TorrentBuilder

Alias to TorrentBuilder::new()

pub fn start(&self)

Start or resume the torrent

pub fn stop(&self)

Stop (pause) the torrent

pub fn remove(self, with_data: bool)

Removes a torrent from the downloads Consumes the Torrent

pub fn verify(&self)

Verify the torrent

pub fn name(&self) -> &str

This torrent's name

pub fn id(&self) -> i32

The unique ID of the torrent

pub fn stats(&self) -> TorrentStats

The stats of the torrent as given by Transmission

These are only available after the torrent has been added to a session

pub fn info(&self) -> TorrentInfo

The info of the torrent as given by Transmission

This is available after the torrent has been parsed and does not need to be added to a session.

pub fn set_ratio(&mut self, limit: f64)

Set the seed ratio of the torrent

pub fn set_download_dir(&mut self, download_dir: PathBuf)

Set the download directory of the torrent

pub fn set_priority(&mut self, priority: Priority)

Set the priority of the torrent

See Priority for more information

pub fn get_file_index(&self, file: &TorrentFile) -> Option<usize>

File Related Functions

Get the index of a file in a torrent

pub fn set_file_download(&mut self, file: TorrentFile, download: bool)

pub fn set_files_download(&mut self, files: Vec<TorrentFile>, download: bool)

Set whether or not a set of files should be downloaded

pub fn set_files_download_by_id(&mut self, ids: Vec<u32>, download: bool)

Set whether or not a set of files, by ids, should be downloaded

pub fn set_file_priority(&mut self, file: TorrentFile, priority: Priority)

pub fn set_files_priorities(
    &mut self,
    files: Vec<TorrentFile>,
    priority: Priority
)

Set the priority of a set of files

pub fn set_files_priorities_by_id(&mut self, ids: Vec<u32>, priority: Priority)

Set the priority of a set of files, by ids

Trait Implementations

impl AsMut<Torrent> for Torrent

fn as_mut(&mut self) -> &mut Self

Performs the conversion.

impl Sync for Torrent

impl Clone for Torrent

fn clone(&self) -> Torrent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Send for Torrent

impl Serialize for Torrent

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.