Struct stop_token::StopSource

pub struct StopSource { /* fields omitted */ }

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

Example:

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

Implementations

impl StopSource

pub fn new() -> StopSource

Creates a new StopSource.

pub fn stop_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.