Struct CancelToken 

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

A cheap, thread-safe flag for cancelling an engine run.

The engine checks the token between batches and executors check it between individual jobs, so cancelling takes effect at job granularity. Clone the token to share it with passes (a pass may cancel a run itself) or with a watchdog thread.

Examples

use increparse::CancelToken;

let token = CancelToken::new();
assert!(!token.is_cancelled());

let shared = token.clone();
shared.cancel();
assert!(token.is_cancelled());

token.reset();
assert!(!token.is_cancelled());

Implementations

impl CancelToken

pub fn new() -> CancelToken

Creates a token in the not-cancelled state.

pub fn cancel(&self)

Marks the run as cancelled.

pub fn reset(&self)

Clears the cancelled state so the token can be reused.

pub fn is_cancelled(&self) -> bool

Returns true if the token has been cancelled.

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<(), Error>

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.