std::sync::BarrierWaitResult - Rust
Description: API documentation for the Rust `BarrierWaitResult` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, BarrierWaitResult

# Struct std::sync::BarrierWaitResult 1.0.0 [−] [src]

    pub struct BarrierWaitResult(_);

A `BarrierWaitResult` is returned by `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();Run

## Methods

### `impl BarrierWaitResult`
[src]

#### `fn is_leader(&self) -> bool`

Returns whether this thread from `wait` is the "leader thread".

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

## Trait Implementations

### `impl Debug for BarrierWaitResult`
1.16.0
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`

Formats the value using the given formatter.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)