Struct TransferHandle 

pub struct TransferHandle { /* private fields */ }

Handle for tracking and controlling a single transfer.

Implementations

impl TransferHandle

pub fn new(total_bytes: u64) -> TransferHandle

Creates a new handle with the provided total byte count.

Panics

This method does not panic.

pub async fn progress(&self) -> TransferProgress

Returns the latest progress snapshot.

Panics

This method does not panic.

pub async fn update_progress(&self, bytes_delta: u64, chunks_delta: u32)

Applies a progress delta for bytes and chunks.

Panics

This method does not panic.

pub async fn set_total_bytes(&self, total_bytes: u64)

Updates the total bytes for the transfer.

Panics

This method does not panic.

pub fn cancel(&self)

Requests cancellation of the transfer.

Panics

This method does not panic.

pub fn is_cancelled(&self) -> bool

Returns true when cancellation has been requested.

Panics

This method does not panic.

Trait Implementations

impl Clone for TransferHandle

fn clone(&self) -> TransferHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransferHandle

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

Formats the value using the given formatter.