Struct BarrierWaitResult

pub struct BarrierWaitResult(pub(in ::sync::barrier) bool);

A BarrierWaitResult is returned by [Barrier::wait()] when all threads in the Barrier have rendezvoused.

Examples

use std::sync::Barrier;

let barrier = Barrier::new(1);
let barrier_wait_result = barrier.wait();

Fields

0: bool

Implementations

impl BarrierWaitResult

fn is_leader(&self) -> bool

Returns true if this thread is the "leader thread" for the call to [Barrier::wait()].

Only one thread will have true returned from their result, all other threads will have false returned.

Examples

use std::sync::Barrier;

let barrier = Barrier::new(1);
let barrier_wait_result = barrier.wait();
println!("{:?}", barrier_wait_result.is_leader());

Trait Implementations

impl Debug for BarrierWaitResult

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

Auto Trait Implementations

impl Freeze for BarrierWaitResult

impl RefUnwindSafe for BarrierWaitResult

impl Send for BarrierWaitResult

impl Sync for BarrierWaitResult

impl Unpin for BarrierWaitResult

impl UnsafeUnpin for BarrierWaitResult

impl UnwindSafe for BarrierWaitResult

Blanket Implementations

impl<T> Any for BarrierWaitResult where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for BarrierWaitResult where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for BarrierWaitResult where T: ?Sized,

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

impl<T> From<T> for BarrierWaitResult

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> SizeHint for BarrierWaitResult where T: ?Sized,

fn lower_bound(&self) -> usize
fn upper_bound(&self) -> Option<usize>

impl<T> SizedTypeProperties for BarrierWaitResult

impl<T, U> Into<U> for BarrierWaitResult where U: From<T>,

fn into(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<U> for BarrierWaitResult where U: Into<T>,

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

impl<T, U> TryInto<U> for BarrierWaitResult where U: TryFrom<T>,

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