Struct CancelToken 

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

A shareable, thread-safe cancellation flag.

clone() is cheap (an Arc bump) — hand one clone to the search config and keep another on the calling side to flip when a timeout elapses.

Implementations

impl CancelToken

pub fn new() -> Self

Create a new, not-yet-cancelled token.

pub fn cancel(&self)

Request cancellation. Safe to call from any thread, at any time, including while a search holding a clone of this token is running.

pub fn is_cancelled(&self) -> bool

Check whether cancellation has been 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.