Struct LocalAsyncScope 

pub struct LocalAsyncScope<'a> { /* private fields */ }

Available on crate feature alloc only.

A LIFO stack of local asynchronous cleanup actions.

Each registration stores one boxed wrapper future. The cleanup factory is invoked only when that wrapper is first polled, and actions are awaited sequentially.

Dropping a pending LocalRun leaves its current action in the stack. A later run resumes it after any newer LIFO entries. Dropping the scope itself drops all remaining actions without polling them further.

Implementations

impl<'a> LocalAsyncScope<'a>

pub const fn new() -> Self

Creates an empty scope.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty scope with space for at least capacity actions.

pub fn defer<F, Fut>(&mut self, action: F)

where F: FnOnce() -> Fut + 'a, Fut: Future<Output = ()> + 'a,

Queues a cleanup factory without invoking it.

pub fn len(&self) -> usize

Returns the number of cleanup actions that have not completed.

pub fn capacity(&self) -> usize

Returns the number of actions the scope can hold without reallocating.

pub fn is_empty(&self) -> bool

Returns true when no cleanup actions remain.

pub fn clear(&mut self)

Drops all queued actions without polling them further.

pub fn run(&mut self) -> LocalRun<'_, 'a>

Borrows the scope and drains its actions in LIFO order.

pub async fn finish(self)

Consumes the scope and runs its actions in LIFO order.

Dropping the returned future also drops every remaining action.

Trait Implementations

impl Debug for LocalAsyncScope<'_>

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

Formats the value using the given formatter.

impl Default for LocalAsyncScope<'_>

fn default() -> Self

Returns the “default value” for a type.