Struct ShutdownToken 

pub struct ShutdownToken { /* private fields */ }

A clonable shutdown token that tasks can poll or wait on.

Contract: this token is a cooperative cancellation primitive. Tasks/threads are expected to poll ShutdownToken::is_shutdown and exit promptly when it becomes true.

Features: waiting APIs require std.

Implementations

impl ShutdownToken

pub fn is_shutdown(&self) -> bool

Returns true iff shutdown has been triggered.

Contract: once true, this will remain true for the lifetime of the token.

pub fn wait(&self)

Block the current thread until shutdown is triggered.

Panics: panics if the internal mutex is poisoned.

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

Block the current thread until shutdown is triggered, or the timeout elapses.

Returns true if shutdown was observed.

Panics: panics if the internal mutex is poisoned.

Trait Implementations

impl Clone for ShutdownToken

fn clone(&self) -> ShutdownToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShutdownToken

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

Formats the value using the given formatter.