Struct Latch 

pub struct Latch { /* private fields */ }

A latch that opens when its count reaches zero, and stays open.

use nuclei::sync::Latch;

let done = Latch::new(2);
done.count_down();
assert!(!done.is_set());
done.count_down();
assert!(done.is_set());

Implementations

impl Latch

pub const fn new(count: usize) -> Self

A latch that opens after count calls to count_down; open at once when count is zero.

pub fn count_down(&self)

Lowers the count by one, opening the latch when it reaches zero. Does nothing once the latch is open.

pub fn count(&self) -> usize

The count still to go.

pub fn is_set(&self) -> bool

Whether the latch is open.

pub fn wait(&self) -> LatchWait<'_>

A future that completes once the latch is open.

Trait Implementations

impl Debug for Latch

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

Formats the value using the given formatter.