Struct CancelToken 

pub struct CancelToken(/* private fields */);

A cancellation signal polled by long-running work.

Implementations

impl CancelToken

pub fn new() -> CancelToken

pub const fn never() -> CancelToken

A token that never cancels, for callers without an abort path.

pub fn from_fn( should_cancel: impl Fn() -> bool + Send + Sync + 'static, ) -> CancelToken

Reads cancellation from an existing condition.

pub fn cancel(&self)

Cancels every clone of this token. A never() token ignores it, and a from_fn token answers from its closure.

pub fn is_cancelled(&self) -> bool

Trait Implementations

impl Clone for CancelToken

fn clone(&self) -> CancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancelToken

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

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.

impl From<CancelToken> for StopSignal

fn from(cancel: CancelToken) -> Self

Converts to this type from the input type.