Struct RunToken

pub struct RunToken(/* private fields */);

Similar to a [tokio_util::sync::CancellationToken], the RunToken encapsulates the possibility of canceling an async command. However it also allows pausing and resuming the async command, and it is possible to wait in both a blocking fashion and an asynchronous fashion.

Implementations

impl RunToken

pub fn new() -> Self

Construct a new running run token

pub fn cancel(&self)

Cancel computation

pub fn is_cancelled(&self) -> bool

Return true iff we are canceled

pub fn cancelled(&self) -> WaitForCancellationFuture<'_>

Suspend the async coroutine until cancel() is called

pub fn set_location(&self, file: &'static str, line: u32)

Store a file line location in the run_token

pub fn location(&self) -> Option<(&'static str, u32)>

Trait Implementations

impl Clone for RunToken

fn clone(&self) -> RunToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RunToken

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

Formats the value using the given formatter.

impl Default for RunToken

fn default() -> Self

Returns the “default value” for a type.