Struct transmission_sys::tr_stat

#[repr(C)]
pub struct tr_stat {
    pub id: c_int,
    pub activity: tr_torrent_activity,
    pub error: tr_stat_errtype,
    pub errorString: [c_char; 512],
    pub recheckProgress: f32,
    pub percentComplete: f32,
    pub metadataPercentComplete: f32,
    pub percentDone: f32,
    pub seedRatioPercentDone: f32,
    pub rawUploadSpeed_KBps: f32,
    pub rawDownloadSpeed_KBps: f32,
    pub pieceUploadSpeed_KBps: f32,
    pub pieceDownloadSpeed_KBps: f32,
    pub eta: c_int,
    pub etaIdle: c_int,
    pub peersConnected: c_int,
    pub peersFrom: [c_int; 7],
    pub peersSendingToUs: c_int,
    pub peersGettingFromUs: c_int,
    pub webseedsSendingToUs: c_int,
    pub sizeWhenDone: u64,
    pub leftUntilDone: u64,
    pub desiredAvailable: u64,
    pub corruptEver: u64,
    pub uploadedEver: u64,
    pub downloadedEver: u64,
    pub haveValid: u64,
    pub haveUnchecked: u64,
    pub manualAnnounceTime: time_t,
    pub ratio: f32,
    pub addedDate: time_t,
    pub doneDate: time_t,
    pub startDate: time_t,
    pub activityDate: time_t,
    pub idleSecs: c_int,
    pub secondsDownloading: c_int,
    pub secondsSeeding: c_int,
    pub finished: bool,
    pub queuePosition: c_int,
    pub isStalled: bool,
}

@brief Used by tr_torrentStat() to tell clients about a torrent's state and statistics

Fields

id: c_int

The torrent's unique Id. @see tr_torrentId()

activity: tr_torrent_activity

What is this torrent doing right now?

error: tr_stat_errtype

Defines what kind of text is in errorString. @see errorString

errorString: [c_char; 512]

A warning or error message regarding the torrent. @see error

recheckProgress: f32

When tr_stat.activity is TR_STATUS_CHECK or TR_STATUS_CHECK_WAIT, this is the percentage of how much of the files has been verified. When it gets to 1, the verify process is done. Range is [0..1] @see tr_stat.activity

percentComplete: f32

How much has been downloaded of the entire torrent. Range is [0..1]

metadataPercentComplete: f32

How much of the metadata the torrent has. For torrents added from a .torrent this will always be 1. For magnet links, this number will from from 0 to 1 as the metadata is downloaded. Range is [0..1]

percentDone: f32

How much has been downloaded of the files the user wants. This differs from percentComplete if the user wants only some of the torrent's files. Range is [0..1] @see tr_stat.leftUntilDone

seedRatioPercentDone: f32

How much has been uploaded to satisfy the seed ratio. This is 1 if the ratio is reached or the torrent is set to seed forever. Range is [0..1]

rawUploadSpeed_KBps: f32

Speed all data being sent for this torrent. This includes piece data, protocol messages, and TCP overhead

rawDownloadSpeed_KBps: f32

Speed all data being received for this torrent. This includes piece data, protocol messages, and TCP overhead

pieceUploadSpeed_KBps: f32

Speed all piece being sent for this torrent. This ONLY counts piece data.

pieceDownloadSpeed_KBps: f32

Speed all piece being received for this torrent. This ONLY counts piece data.

eta: c_int

If downloading, estimated number of seconds left until the torrent is done. If seeding, estimated number of seconds left until seed ratio is reached.

etaIdle: c_int

If seeding, number of seconds left until the idle time limit is reached.

peersConnected: c_int

Number of peers that we're connected to

peersFrom: [c_int; 7]

How many peers we found out about from the tracker, or from pex, or from incoming connections, or from our resume file.

peersSendingToUs: c_int

Number of peers that are sending data to us.

peersGettingFromUs: c_int

Number of peers that we're sending data to

webseedsSendingToUs: c_int

Number of webseeds that are sending data to us.

sizeWhenDone: u64

Byte count of all the piece data we'll have downloaded when we're done, whether or not we have it yet. This may be less than tr_info.totalSize if only some of the torrent's files are wanted. [0...tr_info.totalSize]

leftUntilDone: u64

Byte count of how much data is left to be downloaded until we've got all the pieces that we want. [0...tr_info.sizeWhenDone]

desiredAvailable: u64

Byte count of all the piece data we want and don't have yet, but that a connected peer does have. [0...leftUntilDone]

corruptEver: u64

Byte count of all the corrupt data you've ever downloaded for this torrent. If you're on a poisoned torrent, this number can grow very large.

uploadedEver: u64

Byte count of all data you've ever uploaded for this torrent.

downloadedEver: u64

Byte count of all the non-corrupt data you've ever downloaded for this torrent. If you deleted the files and downloaded a second time, this will be 2*totalSize..

haveValid: u64

Byte count of all the checksum-verified data we have for this torrent.

haveUnchecked: u64

Byte count of all the partial piece data we have for this torrent. As pieces become complete, this value may decrease as portions of it are moved to corrupt' orhaveValid'.

manualAnnounceTime: time_t

time when one or more of the torrent's trackers will allow you to manually ask for more peers, or 0 if you can't

ratio: f32

TR_RATIO_INF, TR_RATIO_NA, or a regular ratio

addedDate: time_t

When the torrent was first added.

doneDate: time_t

When the torrent finished downloading.

startDate: time_t

When the torrent was last started.

activityDate: time_t

The last time we uploaded or downloaded piece data on this torrent.

idleSecs: c_int

Number of seconds since the last activity (or since started). -1 if activity is not seeding or downloading.

secondsDownloading: c_int

Cumulative seconds the torrent's ever spent downloading

secondsSeeding: c_int

Cumulative seconds the torrent's ever spent seeding

finished: bool

A torrent is considered finished if it has met its seed ratio. As a result, only paused torrents can be finished.

queuePosition: c_int

This torrent's queue position. All torrents have a queue position, even if it's not queued.

isStalled: bool

True if the torrent is running, but has been idle for long enough to be considered stalled. @see tr_sessionGetQueueStalledMinutes()

Trait Implementations

impl Copy for tr_stat

impl Clone for tr_stat

fn clone(&self) -> tr_stat

Returns a copy of the value.

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

Performs copy-assignment from source.