Struct CancellationHandle 

pub struct CancellationHandle { /* private fields */ }

Runtime-owned handle that can request cancellation for shared contexts.

Implementations

impl CancellationHandle

pub fn new() -> Self

Create a cancellation handle with an active token.

pub fn token(&self) -> CancellationToken

Return a read-only token suitable for attaching to a NodeContext.

pub fn cancel(&self, request: CancellationRequest) -> bool

Request cancellation for every context sharing this handle’s token.

Returns true when this call recorded the first cancellation request.

pub fn is_cancelled(&self) -> bool

Return whether cancellation has been requested.

pub fn request(&self) -> Option<CancellationRequest>

Return the current cancellation request, if any.

Trait Implementations

impl Clone for CancellationHandle

fn clone(&self) -> CancellationHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CancellationHandle

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

Formats the value using the given formatter.

impl Default for CancellationHandle

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CancellationHandle

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

Tests for self and other values to be equal, and is used by ==.

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 CancellationHandle

impl StructuralPartialEq for CancellationHandle