Struct CancelProgress 

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

ProgressSink that stops forwarding once Cancel or ProgressSink::should_cancel fires.

Long checkout loops call Self::finish_poll after apply so callers get crate::error::Error::Cancelled even when cancellation happened on an ProgressSink::inc boundary.

Implementations

impl<'a> CancelProgress<'a>

pub fn new(inner: &'a mut dyn ProgressSink, cancel: &'a dyn Cancel) -> Self

Wrap inner so every progress update observes cancel.

pub fn stopped(&self) -> bool

Whether a cancel signal was observed.

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

Returns crate::error::Error::Cancelled when Self::stopped.

Trait Implementations

impl ProgressSink for CancelProgress<'_>

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.