Struct aria2_ws::response::Status

pub struct Status {

    pub gid: String,
    pub status: TaskStatus,
    pub total_length: u64,
    pub completed_length: u64,
    pub upload_length: u64,
    pub bitfield: Option<String>,
    pub download_speed: u64,
    pub upload_speed: u64,
    pub info_hash: Option<String>,
    pub num_seeders: Option<u64>,
    pub seeder: Option<bool>,
    pub piece_length: u64,
    pub num_pieces: u64,
    pub connections: u64,
    pub error_code: Option<String>,
    pub error_message: Option<String>,
    pub followed_by: Option<Vec<String>>,
    pub following: Option<String>,
    pub belongs_to: Option<String>,
    pub dir: String,
    pub files: Vec<File>,
    pub bittorrent: Option<BittorrentStatus>,
    pub verified_length: Option<u64>,
    pub verify_integrity_pending: Option<bool>,
}

Full status of a task.

https://aria2.github.io/manual/en/html/aria2c.html#aria2.tellStatus

Fields

gid: String

GID of the download.

status: TaskStatus

total_length: u64

completed_length: u64

upload_length: u64

bitfield: Option<String>

Hexadecimal representation of the download progress.

The highest bit corresponds to the piece at index 0.

Any set bits indicate loaded pieces, while unset bits indicate not yet loaded and/or missing pieces.

Any overflow bits at the end are set to zero.

When the download was not started yet, this key will not be included in the response.

download_speed: u64

upload_speed: u64

info_hash: Option<String>

InfoHash. BitTorrent only

num_seeders: Option<u64>

seeder: Option<bool>

true if the local endpoint is a seeder. Otherwise false. BitTorrent only.

piece_length: u64

num_pieces: u64

connections: u64

error_code: Option<String>

error_message: Option<String>

followed_by: Option<Vec<String>>

List of GIDs which are generated as the result of this download.

For example, when aria2 downloads a Metalink file, it generates downloads described in the Metalink (see the –follow-metalink option).

This value is useful to track auto-generated downloads.

If there are no such downloads, this key will not be included in the response.

following: Option<String>

The reverse link for followedBy.

A download included in followedBy has this object’s GID in its following value.

belongs_to: Option<String>

GID of a parent download.

Some downloads are a part of another download.

For example, if a file in a Metalink has BitTorrent resources, the downloads of “.torrent” files are parts of that parent.

If this download has no parent, this key will not be included in the response.

dir: String

files: Vec<File>

bittorrent: Option<BittorrentStatus>

verified_length: Option<u64>

The number of verified number of bytes while the files are being hash checked.

This key exists only when this download is being hash checked.

verify_integrity_pending: Option<bool>

true if this download is waiting for the hash check in a queue.

This key exists only when this download is in the queue.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Status

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Status> for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Status

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

Serialize this value into the given Serde serializer.

impl Eq for Status

impl StructuralEq for Status

impl StructuralPartialEq for Status