Struct SweepControl 

pub struct SweepControl { /* private fields */ }

Pause, resume and abort switch for a sweep, shared by clones.

Executors call Self::proceed between slices of steps. An abort is final.

Implementations

impl SweepControl

pub fn new() -> Self

Returns a control that lets runs through.

pub fn pause(&self)

Holds every run at its next slice. Note that a pause after an abort changes nothing.

pub fn resume(&self)

Lets paused runs continue.

pub fn abort(&self)

Ends every run at its next slice, paused runs included.

pub fn is_paused(&self) -> bool

Returns whether the runs are held by a pause.

pub fn is_aborted(&self) -> bool

Returns whether the sweep is aborted.

pub fn proceed(&self) -> bool

Returns whether a run can take its next slice, blocking while the sweep is paused.

Returns false once the sweep is aborted.

Panics

Panics or traps on wasm32 while the sweep is paused on a thread that cannot wait, such as a browser’s main thread. A host on wasm32 reads Self::is_paused between slices instead.

Trait Implementations

impl Clone for SweepControl

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SweepControl

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

Formats the value using the given formatter.

impl Default for SweepControl

fn default() -> Self

Returns the “default value” for a type.