Struct StopSource 

pub struct StopSource { /* private fields */ }

Authority that can request cooperative shutdown for one lifecycle scope.

Implementations

impl StopSource

pub fn new() -> StopSource

Create a fresh lifecycle source in the running state.

pub fn token(&self) -> StopToken

Create a read-only token linked to this source.

pub fn request_stop(&self)

Request shutdown for every token linked to this source.

This operation is idempotent and monotonic; there is no resume state.

pub fn is_stop_requested(&self) -> bool

Return whether this source has requested shutdown.

Trait Implementations

impl Clone for StopSource

fn clone(&self) -> StopSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StopSource

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

Formats the value using the given formatter.

impl Default for StopSource

fn default() -> StopSource

Returns the “default value” for a type.