Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Read-only cancellation view carried by a node execution context.

Implementations

impl CancellationToken

pub fn active() -> Self

Create an active cancellation token.

pub fn cancelled(request: CancellationRequest) -> Self

Create a token that already has cancellation requested.

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

Return the current cancellation request, if any.

pub fn state(&self) -> CancellationState

Return the current cancellation state.

pub fn is_cancelled(&self) -> bool

Return whether cancellation has been requested.

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

Formats the value using the given formatter.

impl Default for CancellationToken

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CancellationToken

fn eq(&self, other: &Self) -> 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 CancellationToken