Struct Watch 

pub struct Watch { /* private fields */ }

A scope’s progress watch: cancellation flag plus an optional sink that receives stage names as the operation passes them.

Implementations

impl Watch

pub fn new() -> Self

A watch with no sink: cancellation only.

pub fn with_sink(sink: impl Fn(&str) + Send + Sync + 'static) -> Self

A watch whose sink hears each stage name once as the operation reaches it. The sink runs on whichever thread reaches the stage.

The name-only convenience: a sink that also wants the counts behind a determinate progress bar installs Watch::with_stage_sink.

pub fn with_stage_sink(sink: impl Fn(Stage<'_>) + Send + Sync + 'static) -> Self

A watch whose sink hears each full Stage announcement: the name, and (done, total) where the operation states them. The sink runs on whichever thread reaches the stage; a parallel stage’s counts arrive in completion order, each value once.

pub fn canceller(&self) -> Canceller

The handle that cancels this watch, cloneable and sendable to whatever owns the stop button.

Trait Implementations

impl Debug for Watch

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

Formats the value using the given formatter.

impl Default for Watch

fn default() -> Self

Returns the “default value” for a type.