Struct Barrier 

pub struct Barrier { /* private fields */ }

A barrier that releases its waiters in groups of n.

The n-th wait of a generation completes at once as its leader and wakes the other n - 1; the barrier then starts the next generation. A wait dropped before its generation completes stays counted: the generation completes once n parties have arrived, and the dropped one is simply not woken. (Taking the arrival back would race with the arrival that completes the generation.)

use nuclei::sync::Barrier;
use std::future::Future;
use std::pin::pin;
use std::task::{Context, Waker};

let barrier = Barrier::new(2);
let mut cx = Context::from_waker(Waker::noop());
let mut first = pin!(barrier.wait());
assert!(first.as_mut().poll(&mut cx).is_pending());
let mut second = pin!(barrier.wait());
assert!(second.as_mut().poll(&mut cx).is_ready());
assert!(first.poll(&mut cx).is_ready());

Implementations

impl Barrier

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

A barrier for groups of n waits; 0 acts as 1, as it does for std::sync::Barrier.

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

A future that completes when this wait’s generation is complete.

Trait Implementations

impl Debug for Barrier

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

Formats the value using the given formatter.

impl Drop for Barrier

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Send for Barrier

impl Sync for Barrier