Struct pinned_sync::Barrier

pub struct Barrier { /* fields omitted */ }

A barrier enables multiple threads to synchronize the beginning of some computation.

Implementations

impl Barrier

pub const fn uninit(n: usize) -> Barrier

Creates an uninitialized barrier that can block a given number of threads.

A barrier will block n-1 threads which call wait() and then wake up all threads at once when the nth thread calls wait().

pub fn boxed(n: usize) -> Pin<Box<Self>>

Create a new, initialized Barrier.

The resulting mutex is wrapped and ready for use.

pub fn arc(n: usize) -> Pin<Arc<Self>>

Create a new, initialized Barrier.

The resulting mutex is wrapped and ready for use.

pub fn init(self: Pin<&Self>)

Initializes the barrier.

pub fn wait(self: Pin<&Self>) -> BarrierWaitResult

Blocks the current thread until all threads have rendezvoused here.

Barriers are re-usable after all threads have rendezvoused once, and can be used continuously.

A single (arbitrary) thread will receive a BarrierWaitResult that returns true from BarrierWaitResult::is_leader() when returning from this function, and all other threads will receive a result that will return false from BarrierWaitResult::is_leader().

Trait Implementations

impl Debug for Barrier

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

Formats the value using the given formatter.