Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cloneable cooperative cancellation flag.

Implementations

impl CancellationToken

pub fn new() -> CancellationToken

Creates a non-cancelled token.

pub fn cancel(&self)

Requests cancellation.

pub fn is_cancelled(&self) -> bool

Reports whether cancellation has been requested.

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

Waits for cancellation or until timeout elapses.

Returns true when cancellation was requested.

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 Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.

impl Eq for CancellationToken

impl PartialEq for CancellationToken

fn eq(&self, other: &CancellationToken) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.