Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

A handle to be able to stop the Graph. For example when the user presses Ctrl-C.

use rustradio::graph::CancellationToken;
use std::thread;

// Token normally extracted from graph.cancel_token().
let token = CancellationToken::new();

// Confirm it defaults to not cancelled.
assert!(!token.is_canceled());

// Start a thread that will cancel the token.
let tt = token.clone();
assert!(!token.is_canceled());
assert!(!tt.is_canceled());
thread::spawn(move || {
   tt.cancel();
});

// This would normally be graph.run();
while !token.is_canceled() {}

Implementations

impl CancellationToken

pub fn new() -> Self

Create new cancellation token.

pub fn cancel(&self)

Mark the token cancelled.

pub fn is_canceled(&self) -> bool

Check if the 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 Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.