impl Barrier

const fn new(n: usize) -> Barrier

Creates a new barrier that can block a given number of threads.

A barrier will block all threads which call wait() until the nth thread calls wait(), and then wake up all threads at once.

Examples

use std::sync::Barrier;

let barrier = Barrier::new(10);

fn wait(self: &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()].

Examples

use std::sync::Barrier;
use std::thread;

let n = 10;
let barrier = Barrier::new(n);
thread::scope(|s| {
    for _ in 0..n {
        // The same messages will be printed together.
        // You will NOT see any interleaving.
        s.spawn(|| {
            println!("before wait");
            barrier.wait();
            println!("after wait");
        });
    }
});

impl Debug for Barrier

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

impl Freeze for Barrier

impl RefUnwindSafe for Barrier

impl Send for Barrier

impl Sync for Barrier

impl Unpin for Barrier

impl UnsafeUnpin for Barrier

impl UnwindSafe for Barrier

impl<T> Any for Barrier

fn type_id(self: &Self) -> TypeId

impl<T> Borrow for Barrier

fn borrow(self: &Self) -> &T

impl<T> BorrowMut for Barrier

fn borrow_mut(self: &mut Self) -> &mut T

impl<T> From for Barrier

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Barrier

fn into(self: Self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom for Barrier

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto for Barrier

fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error>