Struct TransferHandle 

pub struct TransferHandle { /* private fields */ }

Handle for tracking and controlling an offload transfer.

Obtained from OffloadEngine::enqueue(). Use this to:

• Monitor transfer progress via status(), passed_blocks(), etc.
• Cancel the transfer via cancel() and await confirmation
• Wait for completion via wait()

Implementations

impl TransferHandle

pub fn id(&self) -> TransferId

Get the transfer ID.

pub fn status(&self) -> TransferStatus

Get the current transfer status.

pub fn passed_blocks(&self) -> Vec<BlockId>

Get blocks that passed all filter policies.

pub fn completed_blocks(&self) -> Vec<BlockId>

Get blocks that have been successfully transferred.

pub fn failed_blocks(&self) -> Vec<BlockId>

Get blocks that failed transfer.

pub fn remaining_blocks(&self) -> Vec<BlockId>

Get blocks remaining to be transferred.

pub fn progress_counts(&self) -> TransferProgressCounts

Return constant-size progress counts without cloning block vectors.

pub fn new_progress_cursor(&self) -> TransferProgressCursor

Create a cursor that consumes this transfer’s progress from the start.

pub fn consume_progress( &self, cursor: &mut TransferProgressCursor, ) -> TransferProgressDelta

Read each newly passed, completed, or failed block exactly once for this cursor, then advance the cursor to the current progress boundary.

pub fn is_complete(&self) -> bool

Check if the transfer is complete (success, cancelled, or failed).

pub fn cancel(&self) -> CancelConfirmation

Cancel the transfer and await confirmation.

Returns a future that resolves when all blocks are confirmed released with no outstanding operations.

Example

// Request cancellation and wait for confirmation
handle.cancel().wait().await;
// All blocks are now released

pub fn is_cancelled(&self) -> bool

Check if cancellation has been requested.

pub async fn wait(&mut self) -> Result<TransferResult>

Wait for the transfer to complete.

Returns the final TransferResult when the transfer reaches a terminal state.

pub fn subscribe_status(&self) -> Receiver<TransferStatus>

Subscribe to status changes.

pub fn subscribe_progress(&self) -> Receiver<TransferProgressCounts>

Subscribe to constant-size block progress counts.

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

Formats the value using the given formatter.