Struct WatchProgress 

pub struct WatchProgress<'a> { /* private fields */ }

ProgressSink adapter that mirrors ProgressSink::should_cancel into watch.

Implementations

impl<'a> WatchProgress<'a>

pub fn new(inner: &'a mut dyn ProgressSink, watch: Arc<AtomicBool>) -> Self

Wrap inner so any cancel request on the sink sets watch.

Trait Implementations

impl ProgressSink for WatchProgress<'_>

fn start(&mut self, phase: ProgressPhase, total: Option<u64>)

Begin a new progress phase, optionally with a known total count of ProgressPhase::default_unit units for that phase.

fn start_with_unit( &mut self, phase: ProgressPhase, unit: ProgressUnit, total: Option<u64>, )

Begin a phase with an explicit count unit (for example ProgressUnit::Bytes when streaming a pack whose size is known in bytes).

fn inc(&mut self, units: u64)

Advance the current phase by units in the active phase unit.

fn set(&mut self, current: u64)

Set the absolute progress of the current phase to current units.

fn finish(&mut self)

Finish the current phase.

fn should_cancel(&self) -> bool

When true, the operation should stop at the next poll_cancel check.