Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cancellation request handed to remote adapters with each read.

The cache cancels the token once the read deadline passes. Cancellation is a request; it does not prove that a dispatched command stopped.

Implementations

impl CancelToken

pub fn new() -> Self

A token that has not been cancelled; clones share its state.

pub fn is_cancelled(&self) -> bool

Whether cancellation was requested.

pub fn cancel(&self)

Request cancellation once. Later calls do nothing.

pub fn on_cancel(&self, callback: impl FnOnce() + Send + 'static)

Run callback when cancellation is requested, or immediately if it already was.

pub fn cancelled(&self) -> Cancelled

Completes once cancellation is requested.

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.