Struct AbortController

pub struct AbortController { /* private fields */ }

A controller for managing abort signals.

AbortController provides a way to create and control AbortSignals. It follows the DOM AbortController specification and allows for cancelling operations by calling the abort() method.

Each controller manages exactly one signal, which can be retrieved using the signal() method. The signal can be cloned and shared as needed.

Examples

use fetchttp::AbortController;

let controller = AbortController::new();
let signal = controller.signal().clone();

// Use the signal in an operation
assert!(!signal.aborted());

// Cancel the operation
controller.abort();
assert!(signal.aborted());

Implementations

impl AbortController

pub fn new() -> Self

Create a new abort controller with a new signal.

The signal starts in a non-aborted state and can be aborted later by calling abort().

Examples

use fetchttp::AbortController;

let controller = AbortController::new();
assert!(!controller.signal().aborted());

pub fn signal(&self) -> &AbortSignal

Get a reference to the signal managed by this controller.

The signal can be cloned and shared as needed. All clones will reflect the same abort state.

Returns

A reference to the AbortSignal managed by this controller.

Examples

use fetchttp::AbortController;

let controller = AbortController::new();
let signal1 = controller.signal().clone();
let signal2 = controller.signal().clone();

// Both signals will show the same state
controller.abort();
assert!(signal1.aborted());
assert!(signal2.aborted());

pub fn abort(&self)

Abort the signal managed by this controller.

This method aborts the signal with a default reason of “AbortError”. Once aborted, the signal cannot be un-aborted.

Examples

use fetchttp::AbortController;

let controller = AbortController::new();
let signal = controller.signal();

assert!(!signal.aborted());

controller.abort();
assert!(signal.aborted());
assert_eq!(signal.reason().unwrap(), "AbortError");

Trait Implementations

impl Debug for AbortController

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

Formats the value using the given formatter.

impl Default for AbortController

fn default() -> Self

Returns the “default value” for a type.