Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cloneable cooperative cancellation flag.

Managed sessions use this internally to ask their worker loop to stop. It is exported for callers that want the same simple cancellation primitive in code built around irtt-client.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a token in the non-cancelled state.

pub fn cancel(&self)

Mark the token as cancelled.

Cancellation is idempotent and is visible through all clones of the token.

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() -> CancellationToken

Returns the “default value” for a type.