Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Propagates notification that operations should be canceled.

Implementations

impl CancellationToken

pub const fn none() -> CancellationToken

A token that can never be canceled.

pub fn can_be_canceled(&self) -> bool

Whether this token is capable of being in the canceled state.

pub fn is_cancellation_requested(&self) -> bool

pub fn register( &self, callback: impl FnOnce() + Send + 'static, ) -> CancellationTokenRegistration

Registers a callback that runs when the token is canceled. When the token is already canceled the callback runs immediately.

impl CancellationToken

pub fn register_local( &self, callback: impl FnOnce() + 'static, ) -> LocalCancellationTokenRegistration

Registers a callback that runs on the current thread when the token is canceled: at once when it is canceled on this thread, or already canceled; through the poster of this thread, or its queue of run_pending_wakes, when it is canceled on another thread. The callback need not be Send.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.