Skip to main content

TaskOptions

Struct TaskOptions 

Source
pub struct TaskOptions {
Show 21 fields pub output: Option<PathBuf>, pub connections: Option<usize>, pub rate_limit: Option<u64>, pub file_jobs: Option<usize>, pub mirrors: Vec<Url>, pub priority: Option<i32>, pub resume: Option<bool>, pub verify: Option<VerifyMode>, pub checksum: Option<Checksum>, pub extract: Option<bool>, pub extract_dir: Option<PathBuf>, pub delete_archive: Option<bool>, pub cache: Option<bool>, pub content_cache: Option<bool>, pub request: RequestOptions, pub revision: Option<String>, pub include: Vec<String>, pub exclude: Vec<String>, pub overwrite: bool, pub rename_on_conflict: bool, pub force: bool,
}
Expand description

Per-task overrides captured when a task is added. Unset fields fall back to the corresponding Config defaults.

Fields§

§output: Option<PathBuf>

Output file or directory override for a single-file direct link.

§connections: Option<usize>

Number of parallel connections used for this task.

§rate_limit: Option<u64>

Additional bandwidth cap for this task in bytes per second. None or Some(0) means no task-specific cap; the global limit still applies.

§file_jobs: Option<usize>

Number of files downloaded concurrently within this task.

§mirrors: Vec<Url>

Alternate HTTP(S) URLs for the same file. They are tried after the primary URL fails and must pass a size/validator compatibility check.

§priority: Option<i32>

Queue priority; larger values are scheduled first.

§resume: Option<bool>

Whether to resume from existing partial data.

§verify: Option<VerifyMode>

Checksum verification policy for this task.

§checksum: Option<Checksum>

Expected checksum for the downloaded content.

§extract: Option<bool>

Whether to extract archives after downloading.

§extract_dir: Option<PathBuf>

Directory to extract archives into.

§delete_archive: Option<bool>

Whether to delete the archive after successful extraction.

§cache: Option<bool>

Use the provider cache for Hub tasks (HF-compatible layout for HF).

§content_cache: Option<bool>

Reuse verified files through the content-addressed cache.

§request: RequestOptions

Per-task headers, authentication and cross-origin policy.

§revision: Option<String>

Hub revision (branch, tag or commit) to download.

§include: Vec<String>

Glob patterns selecting which Hub or BitTorrent files to download.

§exclude: Vec<String>

Glob patterns excluding Hub or BitTorrent files from the download.

§overwrite: bool

Overwrite existing destination files.

§rename_on_conflict: bool

Rename conflicting destinations (name-1.ext, name-2.ext, …) instead of failing.

§force: bool

Add-time only; persisted for diagnostics.

Trait Implementations§

Source§

impl Clone for TaskOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TaskOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TaskOptions

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TaskOptions

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more