Skip to main content

Task

Struct Task 

Source
#[non_exhaustive]
pub struct Task {
Show 14 fields pub schema_version: u32, pub id: TaskId, pub link: Link, pub resource: Option<Resource>, pub backend: Option<String>, pub destination: PathBuf, pub options: TaskOptions, pub priority: i32, pub state: TaskState, pub files: Vec<FileItem>, pub resume: Option<TaskResume>, pub error: Option<String>, pub created_at_ms: u64, pub updated_at_ms: u64,
}
Expand description

A persisted download task: the requested link, its resolved resource, destination and current progress.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§schema_version: u32

Sidecar schema version; see TASK_SCHEMA_VERSION.

§id: TaskId

Unique task id, also used as the sidecar file name.

§link: Link

Original link supplied by the user.

§resource: Option<Resource>

Parsed, backend-agnostic description of what to download.

§backend: Option<String>

Name of the backend selected to execute the task.

§destination: PathBuf

Root directory that relative output paths are resolved against.

§options: TaskOptions

Per-task options supplied when the task was added.

§priority: i32

Queue priority; larger values run first.

§state: TaskState

Current lifecycle state of the task.

§files: Vec<FileItem>

Per-file progress entries generated from the resource.

§resume: Option<TaskResume>

Per-file resume checkpoints written while downloading.

§error: Option<String>

Error message from the most recent failure, if any.

§created_at_ms: u64

Creation timestamp in Unix milliseconds.

§updated_at_ms: u64

Timestamp of the last modification in Unix milliseconds.

Implementations§

Source§

impl Task

Source

pub fn new(link: Link, destination: PathBuf, options: TaskOptions) -> Self

Create a pending task with a fresh id and current timestamps. The file list stays empty until Task::set_resource is called.

Source

pub fn touch(&mut self)

Refresh updated_at_ms to the current time.

Source

pub fn key(&self) -> String

De-duplication key built from the canonical link and the destination path.

Source

pub fn set_resource(&mut self, resource: Resource)

Attach the resolved resource and rebuild the per-file progress entries from it.

Source

pub fn refresh_from_resume(&mut self)

Pull completed byte counts and final paths back from the resume manifest so status/list show meaningful progress.

Source

pub fn total_bytes(&self) -> Option<u64>

Total size of all files in bytes, or None if any file has an unknown size.

Source

pub fn downloaded_bytes(&self) -> u64

Sum of the bytes downloaded so far across all files.

Trait Implementations§

Source§

impl Clone for Task

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 Task

Source§

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

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

impl<'de> Deserialize<'de> for Task

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 Task

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§

§

impl Forget for Task

§

impl Freeze for Task

§

impl Move for Task

§

impl RefUnwindSafe for Task

§

impl Send for Task

§

impl Sync for Task

§

impl Unpin for Task

§

impl UnsafeUnpin for Task

§

impl UnwindSafe for Task

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