Struct std::sync::Barrier

1.0.0 · source ·

pub struct Barrier { /* private fields */ }

Expand description

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

Examples

use std::sync::{Arc, Barrier};
use std::thread;
let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(Barrier::new(10));
for _ in 0..10 {
 let c = Arc::clone(&barrier);
 // The same messages will be printed together.
 // You will NOT see any interleaving.
 handles.push(thread::spawn(move|| {
 println!("before wait");
 c.wait();
 println!("after wait");
 }));
}
// Wait for other threads to finish.
for handle in handles {
 handle.join().unwrap();
}

Run

Implementations

source

impl Barrier

source

pub fn new(n: usize) -> Barrier

Creates a new 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().

Examples

use std::sync::Barrier;
let barrier = Barrier::new(10);

Run

source

pub fn wait(&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::{Arc, Barrier};
use std::thread;
let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(Barrier::new(10));
for _ in 0..10 {
 let c = Arc::clone(&barrier);
 // The same messages will be printed together.
 // You will NOT see any interleaving.
 handles.push(thread::spawn(move|| {
 println!("before wait");
 c.wait();
 println!("after wait");
 }));
}
// Wait for other threads to finish.
for handle in handles {
 handle.join().unwrap();
}

Run

Trait Implementations

1.16.0 · source

impl Debug for Barrier

source

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

Formats the value using the given formatter. Read more