Struct ProgressWithStop 

pub struct ProgressWithStop<S, R> {
    pub stop: S,
    pub report: R,
}

A stop policy and a progress sink used as one value.

check goes to stop and advance goes to report, so the pair works wherever Stop + Report is expected, including ProgressExt::step. ProgressWithStop::new(Unstoppable, NoReport) is zero-sized.

Fields

stop: S

The cancellation policy.

report: R

The completed-work sink.

Implementations

impl<S, R> ProgressWithStop<S, R>

pub const fn new(stop: S, report: R) -> Self

Pair a stop policy with a progress sink.

Trait Implementations

impl<S: Clone, R: Clone> Clone for ProgressWithStop<S, R>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Copy, R: Copy> Copy for ProgressWithStop<S, R>

impl<S: Debug, R: Debug> Debug for ProgressWithStop<S, R>

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

Formats the value using the given formatter.

impl<S: Default, R: Default> Default for ProgressWithStop<S, R>

fn default() -> Self

Returns the “default value” for a type.

impl<S: Eq, R: Eq> Eq for ProgressWithStop<S, R>

impl<S: Hash, R: Hash> Hash for ProgressWithStop<S, R>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<S: PartialEq, R: PartialEq> PartialEq for ProgressWithStop<S, R>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<S: Send + Sync, R: Report> Report for ProgressWithStop<S, R>

fn advance(&self, completed: u64)

Add completed finished units.

fn may_report(&self) -> bool

Whether reports have any effect.

impl<S: Stop, R: Send + Sync> Stop for ProgressWithStop<S, R>

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop.

fn may_stop(&self) -> bool

Returns true if this stop can ever signal a stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.

impl<S: PartialEq, R: PartialEq> StructuralPartialEq for ProgressWithStop<S, R>