# Struct BarrierWaitResult

1.0.0 · Source

    pub struct BarrierWaitResult(/* private fields */);

Expand description

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();

## Implementations§

Source§

### impl BarrierWaitResult

1.0.0 · Source

#### pub 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§

1.16.0 · Source§

### impl Debug for BarrierWaitResult

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl Freeze for BarrierWaitResult

§

### impl RefUnwindSafe for BarrierWaitResult

§

### impl Send for BarrierWaitResult

§

### impl Sync for BarrierWaitResult

§

### impl Unpin for BarrierWaitResult

§

### impl UnwindSafe for BarrierWaitResult

## Blanket Implementations§

Source§

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

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

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

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.