Struct CancelToken 

pub struct CancelToken { /* private fields */ }

The producer’s handle on a consumer’s cancel token, accepted as the final parameter of a #[weaveffi::cancellable] async fn.

The handle holds its own reference to the token, so it stays valid after the consumer destroys its reference. Cancellation is enforced by the runtime (the producer’s future is dropped as soon as the token fires); a producer polls is_cancelled only when it wants to clean up cooperatively, for example between batches of work on another thread.

Implementations

impl CancelToken

pub fn is_cancelled(&self) -> bool

Whether the consumer has requested cancellation.

Trait Implementations

impl Clone for CancelToken

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 CancelToken

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

Formats the value using the given formatter.

impl Default for CancelToken

fn default() -> CancelToken

Returns the “default value” for a type.

impl Drop for CancelToken

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.