Struct CancelToken 

pub struct CancelToken { /* private fields */ }

A cheaply cloneable, thread-safe cancellation flag.

Clones share one flag (the C++ ExecutionContext pimpl semantics), so a token handed to a worker thread can be cancelled from anywhere. Cancellation is sticky: there is no way to un-cancel a token, matching C++, where the flag is deliberately preserved across operation resets. Start a fresh token for work that should be allowed to complete.

Example

use manifold_rust::cancel::CancelToken;
use manifold_rust::manifold::Manifold;
use manifold_rust::linalg::Vec3;
use manifold_rust::types::{Error, OpType};

let token = CancelToken::new();
token.cancel();
let a = Manifold::cube(Vec3::splat(1.0), true);
let b = Manifold::cube(Vec3::splat(1.0), true);
let result = a.boolean_with_token(&b, OpType::Add, Some(&token));
assert_eq!(result.status(), Error::Cancelled);

Implementations

impl CancelToken

pub fn new() -> Self

A fresh, uncancelled token.

pub fn cancel(&self)

Request cancellation. Callable from any thread, including while another thread is inside an operation holding a clone of this token.

Relaxed matches C++ cancel.store(true, std::memory_order_relaxed): the flag is advisory and orders nothing else, and the readers only ever use the value to decide whether to stop early.

pub fn is_cancelled(&self) -> bool

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.