Struct DownloadSpec 

pub struct DownloadSpec { /* private fields */ }

Specification for a download task.

Implementations

impl DownloadSpec

pub fn new(url: impl Into<String>) -> Self

Create a new download specification for the given URL.

All other fields are populated with sensible defaults: 4 connections, 1 MiB pieces, 64 MiB memory budget, resume enabled, etc.

pub fn get_url(&self) -> &str

Returns the download URL.

pub fn get_output_path(&self) -> Option<&Path>

Returns the explicit output file path, if set.

pub fn get_output_dir(&self) -> Option<&Path>

Returns the output directory (filename will be derived from the URL or Content-Disposition header).

pub fn get_headers(&self) -> &HashMap<String, String>

Returns the custom HTTP headers that will be sent with every request.

pub fn get_max_connections(&self) -> u32

Returns the maximum number of parallel connections.

pub fn get_connect_timeout(&self) -> Duration

Returns the TCP connect timeout.

pub fn get_all_proxy(&self) -> Option<&str>

Returns the proxy applied to all HTTP/HTTPS requests, if set.

pub fn get_pool_max_idle_per_host(&self) -> usize

Returns the maximum idle HTTP connections kept per host.

pub fn get_pool_idle_timeout(&self) -> Duration

Returns how long idle pooled HTTP connections are retained.

pub fn get_http_proxy(&self) -> Option<&str>

Returns the proxy applied only to plain HTTP requests, if set.

pub fn get_https_proxy(&self) -> Option<&str>

Returns the proxy applied only to HTTPS requests, if set.

pub fn get_read_timeout(&self) -> Duration

Returns the per-request read timeout.

pub fn get_memory_budget(&self) -> usize

Returns the memory budget (in bytes) for the write-back cache.

pub fn get_file_allocation(&self) -> FileAllocation

Returns the file allocation strategy.

pub fn get_channel_buffer(&self) -> usize

Returns the internal channel buffer size.

pub fn get_resume(&self) -> bool

Returns whether resume is enabled.

pub fn get_piece_size(&self) -> u64

Returns the piece size in bytes used for multi-connection splitting.

pub fn get_min_split_size(&self) -> u64

Returns the minimum file size required before the download is split across multiple connections.

pub fn get_min_segment_size(&self) -> u64

Returns the minimum sub-segment size used by dynamic multi-worker splitting.

pub fn get_max_retries(&self) -> u32

Returns the maximum number of retry attempts per segment.

pub fn get_retry_base_delay(&self) -> Duration

Returns the base delay for exponential backoff between retries.

pub fn get_retry_max_delay(&self) -> Duration

Returns the maximum delay cap for exponential backoff.

pub fn get_max_retry_elapsed(&self) -> Option<Duration>

Returns the optional total elapsed retry budget.

pub fn get_max_download_speed(&self) -> u64

Returns the maximum download speed in bytes/sec (0 = unlimited).

pub fn get_checksum(&self) -> Option<&Checksum>

Returns the checksum used for post-download verification, if set.

pub fn get_control_save_interval(&self) -> Duration

Returns the interval for periodic control-file saves.

pub fn get_autosave_sync_every(&self) -> u32

Returns how many autosave ticks are coalesced into one durable save.

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

Set the explicit output file path.

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

Set the output directory. The filename will be derived automatically from the URL or Content-Disposition response header.

pub fn headers(self, headers: HashMap<String, String>) -> Self

Set custom HTTP headers to include in every request.

pub fn max_connections(self, max_connections: u32) -> Self

Set the maximum number of parallel connections (default: 4).

pub fn connect_timeout(self, connect_timeout: Duration) -> Self

Set the TCP connect timeout (default: 30 s).

pub fn http_idle_pool( self, max_idle_per_host: usize, idle_timeout: Duration, ) -> Self

Configure the experimental HTTP idle pool for this download only.

pub fn disable_http_idle_pool(self) -> Self

Disable HTTP idle connection reuse for this download even if the downloader enables it.

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

Set a proxy applied to all HTTP/HTTPS requests for this download only.

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

Set a proxy applied only to plain HTTP requests for this download.

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

Set a proxy applied only to HTTPS requests for this download.

pub fn read_timeout(self, read_timeout: Duration) -> Self

Set the per-request read timeout (default: 60 s).

pub fn memory_budget(self, memory_budget: usize) -> Self

Set the memory budget in bytes for the write-back cache (default: 64 MiB).

pub fn file_allocation(self, file_allocation: FileAllocation) -> Self

Set the file allocation strategy (default: FileAllocation::Prealloc).

pub fn channel_buffer(self, channel_buffer: usize) -> Self

Set the internal channel buffer size (default: 64).

pub fn resume(self, resume: bool) -> Self

Enable or disable resume support (default: true).

pub fn piece_size(self, piece_size: u64) -> Self

Set the piece size in bytes for multi-connection splitting (default: 1 MiB).

pub fn min_split_size(self, min_split_size: u64) -> Self

Set the minimum file size before splitting across connections (default: 10 MiB).

pub fn min_segment_size(self, min_segment_size: u64) -> Self

Set the minimum sub-segment size for dynamic multi-worker splitting.

pub fn max_retries(self, max_retries: u32) -> Self

Set the maximum retry attempts per segment (default: 5).

pub fn retry_base_delay(self, retry_base_delay: Duration) -> Self

Set the base delay for exponential backoff (default: 1 s).

pub fn retry_max_delay(self, retry_max_delay: Duration) -> Self

Set the maximum delay cap for exponential backoff (default: 30 s).

pub fn max_retry_elapsed(self, max_retry_elapsed: Duration) -> Self

Set the total elapsed retry budget for a single request.

pub fn retry_policy( self, max_retries: u32, retry_base_delay: Duration, retry_max_delay: Duration, ) -> Self

Configure the full retry policy in one call.

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

Set the maximum download speed in bytes/sec (default: 0 = unlimited).

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

Set the checksum for post-download integrity verification.

pub fn control_save_interval(self, interval: Duration) -> Self

Set the interval for periodic control-file saves (default: 5 s).

pub fn autosave_sync_every(self, autosave_sync_every: u32) -> Self

Save a durable autosave every N autosave ticks that have unsaved progress.

pub fn validate(&self) -> Result<(), DownloadError>

Validate the configuration and return an error if any value is out of range.

Trait Implementations

impl Clone for DownloadSpec

fn clone(&self) -> DownloadSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DownloadSpec

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

Formats the value using the given formatter.