Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Available on crate feature cli only.

A thread-safe cancellation token that can be shared across threads.

This token allows cooperative cancellation by providing a way to signal cancellation and check cancellation status. The token can be cloned and shared across multiple threads, with all clones sharing the same cancellation state.

Example

use reth_cli_util::cancellation::CancellationToken;
use std::{thread, time::Duration};

let token = CancellationToken::new();
let worker_token = token.clone();

let handle = thread::spawn(move || {
    while !worker_token.is_cancelled() {
        // Do work...
        thread::sleep(Duration::from_millis(100));
    }
});

// Cancel from main thread
token.cancel();
handle.join().unwrap();

Implementations

impl CancellationToken

pub fn new() -> CancellationToken

Creates a new cancellation token in the non-cancelled state.

pub fn cancel(&self)

Signals cancellation to all holders of this token and its clones.

Once cancelled, the token cannot be reset. This operation is thread-safe and can be called multiple times without issue.

pub fn is_cancelled(&self) -> bool

Checks whether cancellation has been requested.

Returns true if cancel has been called on this token or any of its clones.

pub fn drop_guard(&self) -> CancellationGuard

Creates a guard that automatically cancels this token when dropped.

This is useful for ensuring cancellation happens when a scope exits, either normally or via panic.

Example

use reth_cli_util::cancellation::CancellationToken;

let token = CancellationToken::new();
{
    let _guard = token.drop_guard();
    assert!(!token.is_cancelled());
    // Guard dropped here, triggering cancellation
}
assert!(token.is_cancelled());

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationToken

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 8 bytes