Struct AbortSignal 

pub struct AbortSignal { /* private fields */ }

A cancellation signal analogous to the Web AbortSignal.

Timeouts are deliberately not encoded as cancellation reasons. Core owns timeout deadlines and returns crate::AiMuxError::Timeout directly; this type represents only caller-requested cancellation.

Implementations

impl AbortSignal

pub fn new() -> Self

Create a fresh signal.

pub fn abort(&self)

Cancel with the default reason.

pub fn is_aborted(&self) -> bool

Whether cancellation has been requested.

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

Resolve when cancellation is requested.

Trait Implementations

impl Clone for AbortSignal

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 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.