Struct Stop 

pub(crate) struct Stop {
    requested: Mutex<StopState>,
    signal: Condvar,
}

The stop signal a thread and its owner share.

Fields

requested: Mutex<StopState>

Whether a stop has been requested, and whether the thread is over.

Both are facts about the same thread and are waited on by the same callers, so one lock and one condition variable carry them: a waiter that takes the lock, finds nothing and waits holds the lock across the wait, so it cannot miss a signal sent before it went to sleep.

signal: Condvar

Signalled whenever requested or finished turns true.

Implementations

impl Stop

fn request(&self)

Request a stop and wake whoever is waiting on one.

fn finish(&self)

Mark the thread as over and wake whoever is waiting on it.

fn wait_finished(&self, timeout: Duration) -> bool

Wait up to timeout for the thread to finish.

Returns whether it finished in time. A thread that already finished returns at once, and a signal that arrives before the wait does not get missed: the check and the wait happen under one lock.

fn requested(&self) -> bool

Whether a stop has been requested.

Trait Implementations

impl Debug for Stop

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

Formats the value using the given formatter.

impl Default for Stop

fn default() -> Self

Returns the “default value” for a type.