Struct CancellationToken 

pub struct CancellationToken { /* private fields */ }

Cloneable cooperative-cancellation signal shared with provider futures.

Cancellation never terminates a process by itself. Implementations must check the token at bounded intervals and perform their own process-tree or network-request cleanup.

Implementations

impl CancellationToken

pub fn new() -> Self

Create a token in the active state.

pub fn cancel(&self) -> bool

Request cancellation, returning true only for the first request.

pub fn is_cancelled(&self) -> bool

Whether cancellation has been requested.

pub fn check(&self) -> RemoteBuildResult<()>

Return a typed cancellation error after a request.

Errors

Returns RemoteBuildError::Cancelled after cancellation is requested.

Trait Implementations

impl Clone for CancellationToken

fn clone(&self) -> Self

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.