Struct GetTorrentListArg

pub struct GetTorrentListArg {
    pub filter: Option<TorrentFilter>,
    pub category: Option<String>,
    pub tag: Option<String>,
    pub sort: Option<String>,
    pub reverse: Option<bool>,
    pub limit: Option<u64>,
    pub offset: Option<i64>,
    pub hashes: Option<String>,
}

Fields

filter: Option<TorrentFilter>

Filter torrent list by state. Allowed state filters: all, downloading, seeding, completed, paused, active, inactive, resumed, stalled, stalled_uploading, stalled_downloading, errored

category: Option<String>

Get torrents with the given category (empty string means “without category”; no “category” parameter means “any category” <- broken until #11748 is resolved). Remember to URL-encode the category name. For example, My category becomes My%20category

tag: Option<String>

Get torrents with the given tag (empty string means “without tag”; no “tag” parameter means “any tag”. Remember to URL-encode the category name. For example, My tag becomes My%20tag

sort: Option<String>

Sort torrents by given key. They can be sorted using any field of the response’s JSON array (which are documented below) as the sort key.

reverse: Option<bool>

Enable reverse sorting. Defaults to false

limit: Option<u64>

Limit the number of torrents returned

offset: Option<i64>

Set offset (if less than 0, offset from end)

hashes: Option<String>

Filter by hashes. Can contain multiple hashes separated by \|

Implementations

impl GetTorrentListArg

pub fn builder() -> GetTorrentListArgBuilder<((), (), (), (), (), (), (), ())>

Create a builder for building GetTorrentListArg. On the builder, call .filter(...)(optional), .category(...)(optional), .tag(...)(optional), .sort(...)(optional), .reverse(...)(optional), .limit(...)(optional), .offset(...)(optional), .hashes(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetTorrentListArg.

Trait Implementations

impl Clone for GetTorrentListArg

fn clone(&self) -> GetTorrentListArg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetTorrentListArg

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

Formats the value using the given formatter.

impl Default for GetTorrentListArg

fn default() -> GetTorrentListArg

Returns the “default value” for a type.

impl PartialEq for GetTorrentListArg

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for GetTorrentListArg

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetTorrentListArg