Struct DownloadOptions 

pub struct DownloadOptions {

    pub priority: DownloadPriority,
    pub save_dir: Option<PathBuf>,
    pub filename: Option<String>,
    pub user_agent: Option<String>,
    pub referer: Option<String>,
    pub headers: Vec<(String, String)>,
    pub cookies: Option<Vec<String>>,
    pub checksum: Option<ExpectedChecksum>,
    pub mirrors: Vec<String>,
    pub max_connections: Option<usize>,
    pub max_download_speed: Option<u64>,
    pub max_upload_speed: Option<u64>,
    pub seed_ratio: Option<f64>,
    pub selected_files: Option<Vec<usize>>,
    pub sequential: Option<bool>,
}

Options for adding a new download

Fields

priority: DownloadPriority

Download priority (affects queue ordering)

save_dir: Option<PathBuf>

Directory to save files

filename: Option<String>

Output filename

user_agent: Option<String>

Custom user agent

referer: Option<String>

Referer header

headers: Vec<(String, String)>

Additional headers

cookies: Option<Vec<String>>

Cookies for authenticated downloads (e.g., [“session=abc123”, “token=xyz”])

checksum: Option<ExpectedChecksum>

Expected checksum for verification after download (e.g., MD5 or SHA256)

mirrors: Vec<String>

Mirror/fallback URLs for redundancy (tried in order on failure)

max_connections: Option<usize>

Max connections for this download

max_download_speed: Option<u64>

Max download speed (bytes/sec)

max_upload_speed: Option<u64>

Max upload speed (bytes/sec, torrent only)

seed_ratio: Option<f64>

Seed ratio limit (torrent only)

selected_files: Option<Vec<usize>>

Selected file indices (torrent only)

sequential: Option<bool>

Sequential download mode (torrent only) - downloads pieces in order for streaming

Implementations

impl DownloadOptions

pub fn new() -> Self

Create new download options with defaults

pub fn priority(self, priority: DownloadPriority) -> Self

Set download priority

pub fn save_dir(self, dir: impl Into<PathBuf>) -> Self

Set the directory to save files

pub fn filename(self, name: impl Into<String>) -> Self

Set the output filename

pub fn user_agent(self, ua: impl Into<String>) -> Self

Set a custom user agent

pub fn referer(self, referer: impl Into<String>) -> Self

Set the referer header

pub fn header(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add a custom header

pub fn cookies(self, cookies: Vec<String>) -> Self

Set cookies for authenticated downloads

pub fn checksum(self, checksum: ExpectedChecksum) -> Self

Set expected checksum for verification

pub fn mirror(self, url: impl Into<String>) -> Self

Add a mirror/fallback URL

pub fn max_connections(self, n: usize) -> Self

Set max connections for this download

pub fn max_download_speed(self, bps: u64) -> Self

Set max download speed in bytes/sec

pub fn max_upload_speed(self, bps: u64) -> Self

Set max upload speed in bytes/sec (torrent only)

pub fn seed_ratio(self, ratio: f64) -> Self

Set seed ratio limit (torrent only)

pub fn selected_files(self, indices: Vec<usize>) -> Self

Set selected file indices (torrent only)

pub fn sequential(self, enabled: bool) -> Self

Enable sequential download mode for streaming (torrent only)

Trait Implementations

impl Clone for DownloadOptions

fn clone(&self) -> DownloadOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadOptions

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

Formats the value using the given formatter.

impl Default for DownloadOptions

fn default() -> DownloadOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DownloadOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for DownloadOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.