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

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

    pub struct Handle<'rx, T: Send + 'rx> { /* 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

A handle to a receiver which is currently a member of a `Select` set of receivers. This handle is used to keep the receiver in the set as well as interact with the underlying receiver.

## Methods

### `impl<'rx, T: Send> Handle<'rx, T>`
[src]

#### `fn id(&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

Retrieves the id of this handle.

#### `fn recv(&mut self) -> Result<T, RecvError>`

🔬 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

Blocks to receive a value on the underlying receiver, returning `Some` on success or `None` if the channel disconnects. This function has the same semantics as `Receiver.recv`

#### `unsafe fn add(&mut self)`

🔬 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

Adds this handle to the receiver set that the handle was created from. This method can be called multiple times, but it has no effect if `add` was called previously.

This method is unsafe because it requires that the `Handle` is not moved while it is added to the `Select` set.

#### `unsafe fn remove(&mut self)`

🔬 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

Removes this handle from the `Select` set. This method is unsafe because it has no guarantee that the `Handle` was not moved since `add` was called.

## Trait Implementations

### `impl<'rx, T: Send> Drop for Handle<'rx, T>`
[src]

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

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

### `impl<'rx, T: Send + 'rx> Debug for Handle<'rx, T>`
[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`)