[][src]Struct async_std::sync::Barrier

pub struct Barrier { /* fields omitted */ }
This is supported on unstable only.

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

Examples

use async_std::sync::{Arc, Barrier};
use async_std::task;

let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(Barrier::new(10));
for _ in 0..10 {
    let c = barrier.clone();
    // The same messages will be printed together.
    // You will NOT see any interleaving.
    handles.push(task::spawn(async move {
        println!("before wait");
        c.wait().await;
        println!("after wait");
    }));
}
// Wait for the other futures to finish.
for handle in handles {
    handle.await;
}

Methods

impl Barrier[src]

pub fn new(n: usize) -> Barrier[src]

This is supported on unstable only.

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

A barrier will block n-1 tasks which call wait and then wake up all tasks at once when the nth task calls wait.

Examples

use std::sync::Barrier;

let barrier = Barrier::new(10);

pub async fn wait<'_>(&'_ self) -> BarrierWaitResult[src]

This is supported on unstable only.

Blocks the current task until all tasks have rendezvoused here.

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

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

Examples

use async_std::sync::{Arc, Barrier};
use async_std::task;

let mut handles = Vec::with_capacity(10);
let barrier = Arc::new(Barrier::new(10));
for _ in 0..10 {
    let c = barrier.clone();
    // The same messages will be printed together.
    // You will NOT see any interleaving.
    handles.push(task::spawn(async move {
        println!("before wait");
        c.wait().await;
        println!("after wait");
    }));
}
// Wait for the other futures to finish.
for handle in handles {
    handle.await;
}

Trait Implementations

impl Debug for Barrier[src]

Auto Trait Implementations

impl Send for Barrier

impl Sync for Barrier

impl Unpin for Barrier

impl !UnwindSafe for Barrier

impl !RefUnwindSafe for Barrier

Blanket Implementations

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]