Struct RunningProgressNotifier 

pub struct RunningProgressNotifier { /* private fields */ }

Notifies a RunningProgressLoop about progress points and completion.

The notifier is cloneable so workers can share it cheaply. Sending a signal returns false when the loop has already stopped or its receiver was dropped.

Examples

use qubit_progress::RunningProgressLoop;

let (_progress_loop, notifier) = RunningProgressLoop::channel();

assert!(notifier.running_point());
assert!(notifier.stop());

Author

Haixing Hu

Implementations

impl RunningProgressNotifier

pub fn running_point(&self) -> bool

Sends a running progress point signal.

Returns

true when the signal was sent, or false when the matching loop has already stopped.

pub fn stop(&self) -> bool

Sends a stop signal.

Returns

true when the signal was sent, or false when the matching loop has already stopped.

Trait Implementations

impl Clone for RunningProgressNotifier

fn clone(&self) -> RunningProgressNotifier

Returns a duplicate of the value.

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

Performs copy-assignment from source.