Struct StopToken 

pub struct StopToken { /* private fields */ }

The waiting side. Cheap to clone; it sees the stop that its source triggers.

Implementations

impl StopToken

pub fn cause(&self) -> Option<StopCause>

The cause, once the stop has been triggered.

pub fn is_stopped(&self) -> bool

pub fn wait(&self, timeout: Duration) -> Option<StopCause>

Wait up to timeout for the stop. Returns its cause as soon as it is triggered, or None when the timeout passes first. Returns at once when the stop is already set.

Trait Implementations

impl Clone for StopToken

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.