Struct DownloadOperation

Source

pub struct DownloadOperation(/* private fields */);

Expand description

An in-progress or finished download.

Implementations§

Source §

impl DownloadOperation

Source

pub fn uri(&self) -> String

Returns the URI the content is being downloaded from.

Source

pub fn content_disposition(&self) -> String

Returns the Content-Disposition header value from the download’s HTTP response, if any.

Source

pub fn mime_type(&self) -> String

Returns the MIME type of the downloaded content.

Source

pub fn total_bytes_to_receive(&self) -> i64

Returns the expected total size of the download in bytes, or 0 if it is unknown.

Source

pub fn bytes_received(&self) -> i64

Returns the number of bytes received so far.

Source

pub fn result_file_path(&self) -> String

Returns the absolute path the download is being written to.

Source

pub fn state(&self) -> DownloadState

Returns the current DownloadState.

Source

pub fn interrupt_reason(&self) -> DownloadInterruptReason

Returns why the download was interrupted, or DownloadInterruptReason::None if it has not been interrupted.

Source

pub fn can_resume(&self) -> bool

Returns true if an interrupted download can be resumed.

Source

pub fn cancel(&self) -> Result<()>

Cancels the download. The file is deleted if it was not yet complete.

Source

pub fn pause(&self) -> Result<()>

Pauses the download. It stays in progress until resumed or canceled.

Source

pub fn resume(&self) -> Result<()>

Resumes a paused or interrupted download.

Source

pub fn on_bytes_received_changed<F: FnMut(DownloadOperation) + 'static>( &self, handler: F, ) -> Result<EventRegistration>

Subscribes to the bytes-received-changed event, raised as the download makes progress. The handler receives this operation so it can read the updated bytes_received.

Source

pub fn on_state_changed<F: FnMut(DownloadOperation) + 'static>( &self, handler: F, ) -> Result<EventRegistration>

Subscribes to the state-changed event, raised when the download’s state changes (for example to completed or interrupted). The handler receives this operation.