Struct AbortSignal 

pub struct AbortSignal { /* private fields */ }

A cancellation signal analogous to the Web AbortSignal.

Event-driven: backed by tokio_util::sync::CancellationToken (itself a tokio::sync::Notify). Consumers can poll is_aborted synchronously, or await cancelled for prompt, notification-based wakeup — no polling loop needed.

This type is Send + Sync and cheap to clone.

Implementations

impl AbortSignal

pub fn new() -> Self

Create a fresh, un-aborted signal.

pub fn abort(&self)

Request cancellation. All clones observe the aborted state and any pending cancelled futures resolve.

pub fn is_aborted(&self) -> bool

Returns true once abort has been called.

pub fn cancelled(&self) -> impl Future<Output = ()> + Send + 'static

A future that resolves as soon as the signal is aborted.

If the signal is already aborted, the future resolves immediately on the first poll. Suitable for tokio::select! arms.

Trait Implementations

impl Clone for AbortSignal

fn clone(&self) -> AbortSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AbortSignal

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

Formats the value using the given formatter.

impl Default for AbortSignal

fn default() -> Self

Returns the “default value” for a type.