Struct Barrier

pub struct Barrier { /* private fields */ }

Allows for multiple tasks to reach the same point in execution before continuing.

Examples

const N: usize = 10;
let handles = Vec::new();
let barrier = Barrier::new(N);
for i in 0..N {
    spawn(async {
        // Every "Before barrier" will be printed before any "After Barrier".
        println!("Before Barrier");
        barrier.wait().await;
        println!("After Barrier");
    })
}

for handle in handles {
    handle.await;
}

Implementations

impl Barrier

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

Create a new barrier that will block count threads before releasing.

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

Wait for the barrier to be reached by every thread.

A single task will get a BarrierWaitFuture that resolves to true. This is the equivalent of the standard library method BarrierWaitResult::is_leader

Trait Implementations

impl Debug for Barrier

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

Formats the value using the given formatter.