Struct CancelToken 

pub struct CancelToken { /* private fields */ }

Checked at the start of each batch iteration; safe to share across threads.

Implementations

impl CancelToken

pub fn none() -> Self

Never triggers cancellation.

pub fn from_flag(stop: Arc<AtomicBool>) -> Self

pub fn with_hook( hook: Arc<dyn Fn() -> Result<(), String> + Send + Sync>, ) -> Self

pub fn flag(&self) -> Arc<AtomicBool>

pub fn request_stop(&self)

pub fn check(&self) -> Result<(), String>

impl CancelToken

pub fn with_ctrlc_handler() -> Result<(Self, CtrlcGuard), String>

Install a process-wide SIGINT handler that sets the token stop flag.