Struct WorkflowCancellationToken 

pub struct WorkflowCancellationToken { /* private fields */ }

A deterministic cancellation token for workflow operations.

Tokens created with WorkflowCancellationToken::new are detached from workflow cancellation. Use WorkflowCancellationToken::child_token to create a token that is cancelled when its parent is cancelled.

Implementations

impl WorkflowCancellationToken

pub fn new() -> Self

Create a detached cancellation token.

pub fn child_token(&self) -> Self

Create a token that is cancelled when this token is cancelled.

pub fn cancel(&self)

Cancel this token without a reason.

pub fn cancel_with_reason(&self, reason: impl Into<String>)

Cancel this token with a reason.

pub fn is_cancelled(&self) -> bool

Return whether this token has been cancelled.

pub fn reason(&self) -> Option<String>

Return the first cancellation reason, if one was provided.

pub fn cancelled(&self) -> impl FusedFuture<Output = ()> + '_

Return a future that resolves when this token is cancelled.

Trait Implementations

impl Clone for WorkflowCancellationToken

fn clone(&self) -> WorkflowCancellationToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkflowCancellationToken

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

Formats the value using the given formatter.

impl Default for WorkflowCancellationToken

fn default() -> Self

Returns the “default value” for a type.