Struct AbortSignal 

pub struct AbortSignal { /* private fields */ }

A cancellation signal analogous to the Web AbortSignal.

Rust has no built-in AbortSignal; this is a minimal, dependency-free implementation backed by an Arc<AtomicBool>. Providers that want true async cancellation should poll AbortSignal::is_aborted (e.g. inside a tokio::select! arm) or check it between request steps. Callers obtain a signal, hand out clones, and call AbortSignal::abort to request cancellation.

This type is Send + Sync and cheap to clone (a single Arc).

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.

pub fn is_aborted(&self) -> bool

Returns true once abort has been called.

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() -> AbortSignal

Returns the “default value” for a type.