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

# Struct std::sync::mpsc::Select [−] [src]

    pub struct Select { /* fields omitted */ }

🔬 This is a nightly-only experimental API. (`mpsc_select` #27800)

This implementation, while likely sufficient, is unsafe and likely to be error prone. At some point in the future this module will likely be replaced, and it is currently unknown how much API breakage that will cause. The ability to select over a number of channels will remain forever, but no guarantees beyond this are being made

The "receiver set" of the select interface. This structure is used to manage a set of receivers which are being selected over.

## Methods

### `impl Select`
[src]

#### `fn new() -> Select`

🔬 This is a nightly-only experimental API. (`mpsc_select` #27800)

This implementation, while likely sufficient, is unsafe and likely to be error prone. At some point in the future this module will likely be replaced, and it is currently unknown how much API breakage that will cause. The ability to select over a number of channels will remain forever, but no guarantees beyond this are being made

Creates a new selection structure. This set is initially empty.

Usage of this struct directly can sometimes be burdensome, and usage is much easier through the `select!` macro.

# Examples

    #![feature(mpsc_select)]

    use std::sync::mpsc::Select;

    let select = Select::new();Run

#### `fn handle<'a, T: Send>(&'a self, rx: &'a Receiver<T>) -> Handle<'a, T>`

🔬 This is a nightly-only experimental API. (`mpsc_select` #27800)

This implementation, while likely sufficient, is unsafe and likely to be error prone. At some point in the future this module will likely be replaced, and it is currently unknown how much API breakage that will cause. The ability to select over a number of channels will remain forever, but no guarantees beyond this are being made

Creates a new handle into this receiver set for a new receiver. Note that this does not add the receiver to the receiver set, for that you must call the `add` method on the handle itself.

#### `fn wait(&self) -> usize`

🔬 This is a nightly-only experimental API. (`mpsc_select` #27800)

This implementation, while likely sufficient, is unsafe and likely to be error prone. At some point in the future this module will likely be replaced, and it is currently unknown how much API breakage that will cause. The ability to select over a number of channels will remain forever, but no guarantees beyond this are being made

Waits for an event on this receiver set. The returned value is not an index, but rather an id. This id can be queried against any active `Handle` structures (each one has an `id` method). The handle with the matching `id` will have some sort of event available on it. The event could either be that data is available or the corresponding channel has been closed.

## Trait Implementations

### `impl !Send for Select`
[src]

### `impl Drop for Select`
[src]

#### `fn drop(&mut self)`

A method called when the value goes out of scope. Read more

### `impl Debug for Select`
[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`)