Struct AsyncCloser 

pub struct AsyncCloser<S> { /* private fields */ }

Available on crate feature future only.

AsyncCloser holds the two things we need to close a thread and wait for it to finish: a chan to tell the thread to shut down, and a WaitGroup with which to wait for it to finish shutting down.

Implementations

impl<S> AsyncCloser<S>

pub fn new(initial: usize) -> Self

Constructs a new AsyncCloser, with an initial count on the [WaitGroup].

pub fn add_running(&self, running: usize)

Adds delta to the [WaitGroup].

pub fn done(&self)

Calls [WaitGroup::done] on the [WaitGroup].

pub fn signal(&self)

Signals the AsyncCloser::listen signal.

pub async fn wait(&self)

Waits on the [WaitGroup]. (It waits for the AsyncCloser’s initial value, AsyncCloser::add_running, and AsyncCloser::done calls to balance out.)

pub async fn signal_and_wait(&self)

Calls AsyncCloser::signal, then AsyncCloser::wait.

pub fn listen(&self) -> Notify

Gets signaled when AsyncCloser::signal is called.

impl<S: AsyncSpawner> AsyncCloser<S>

pub fn blocking_wait(&self)

Waits on the [WaitGroup]. (It waits for the AsyncCloser’s initial value, AsyncCloser::add_running, and AsyncCloser::done calls to balance out.)

pub fn signal_and_wait_detach(&self)

Like AsyncCloser::signal_and_wait, but spawns and detach the waiting in a new task.

Trait Implementations

impl<S> Clone for AsyncCloser<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug> Debug for AsyncCloser<S>

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

Formats the value using the given formatter.

impl<S> Default for AsyncCloser<S>

fn default() -> Self

Returns the “default value” for a type.