Struct CancellationToken

pub struct CancellationToken { /* private fields */ }

A shared cancellation flag.

Cloning shares the same flag, so one handle cancels work holding any clone.

Implementations

impl CancellationToken

pub fn new() -> Self

A token that is not cancelled.

pub fn cancel(&self)

Request cancellation. Idempotent, and callable from any thread.

pub fn is_cancelled(&self) -> bool

Whether cancellation has been requested.

pub fn check(&self) -> GeomResult<()>

Err(GeomError::Cancelled) when cancelled, else Ok(()).

The shape providers use at a poll point: token.check()?.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> CancellationToken

Returns a copy 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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> CancellationToken

Returns the “default value” for a type.

impl PartialEq for CancellationToken

fn eq(&self, other: &Self) -> bool

Identity comparison: two handles are equal when they share one flag.

Deliberately not a comparison of current cancelled state, which would make two unrelated uncancelled tokens compare equal and then diverge.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CancellationToken