Struct AttemptCancelToken 

pub struct AttemptCancelToken { /* private fields */ }

Cooperative cancellation token passed to blocking timeout attempts.

The retry executor marks the token as cancelled when crate::Retry::run_in_worker stops waiting for a timed-out worker thread. The worker must check AttemptCancelToken::is_cancelled and return on its own; Rust threads cannot be safely killed by the executor.

Implementations

impl AttemptCancelToken

pub fn new() -> Self

Creates a fresh non-cancelled token.

Returns

A token whose cancellation flag is initially false.

pub fn cancel(&self)

Marks this token as cancelled.

Parameters

This method has no parameters.

Side Effects

Sets the shared cancellation flag. Clones of this token observe the same flag.

pub fn is_cancelled(&self) -> bool

Returns whether cancellation has been requested.

Returns

true after the executor or another holder calls AttemptCancelToken::cancel.

Trait Implementations

impl Clone for AttemptCancelToken

fn clone(&self) -> AttemptCancelToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AttemptCancelToken

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

Formats the value using the given formatter.

impl Default for AttemptCancelToken

fn default() -> AttemptCancelToken

Returns the “default value” for a type.