Struct StopSource

pub struct StopSource { /* private fields */ }

StopSource produces StopToken and cancels all of its tokens on drop.

Example:

let source = StopSource::new();
let token = source.token();
schedule_some_work(token);
drop(source); // At this point, scheduled work notices that it is canceled.

Implementations

impl StopSource

pub fn new() -> StopSource

Creates a new StopSource.

pub fn token(&self) -> StopToken

Produces a new StopToken, associated with this source.

Once the source is destroyed, StopToken future completes.

Trait Implementations

impl Debug for StopSource

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

Formats the value using the given formatter.

impl Default for StopSource

fn default() -> StopSource

Returns the “default value” for a type.