Struct StdCancellationToken 

pub struct StdCancellationToken { /* private fields */ }

Trait Implementations

impl CancellationToken for StdCancellationToken

fn error_if_cancelled(&self) -> Result<(), CancellationError>

Performs a one-time check whether the flow of execution is cancelled.

fn on_cancellation<'a>( &self, func: &'a mut CancellationFunc<'a>, ) -> CancellationGuard<'a>

Registers a cancellation handler, which will be invoked when the execution flow is cancelled. The cancellation handler can be called from any thread which initiates the cancellation. If the flow is already cancelled when this function is called, the cancellation handler will be called synchronously. The function returns a guard which can be used to unregister the cancellation handler. After the guard is dropped, the handler is guaranteed not be called anymore.