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

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

    pub struct Handle<'rx, T: Send + 'rx> { /* fields omitted */ }

Deprecated since 1.32.0:

channel selection will be removed in a future release

🔬 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 be removed.

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]

#### `pub fn id(&self) -> usize`[src]

Deprecated since 1.32.0:

channel selection will be removed in a future release

🔬 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 be removed.

Retrieves the id of this handle.

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

Deprecated since 1.32.0:

channel selection will be removed in a future release

🔬 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 be removed.

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`

#### `pub unsafe fn add(&mut self)`[src]

Deprecated since 1.32.0:

channel selection will be removed in a future release

🔬 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 be removed.

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.

#### `pub unsafe fn remove(&mut self)`[src]

Deprecated since 1.32.0:

channel selection will be removed in a future release

🔬 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 be removed.

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 + 'rx> Debug for Handle<'rx, T>`[src]

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

Formats the value using the given formatter. Read more

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

#### `fn drop(&mut self)`[src]

Executes the destructor for this type. Read more

## Auto Trait Implementations

### `impl<'rx, T> !Send for Handle<'rx, T>`

### `impl<'rx, T> !Sync for Handle<'rx, T>`

## Blanket Implementations

### `impl<T> From for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom for T where
T: From<U>,` [src]

#### `type Error = !`

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

### `impl<T, U> TryInto for T where
U: TryFrom<T>,` [src]

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

The type returned in the event of a conversion error.

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

🔬 This is a nightly-only experimental API. (`try_from` #33417)

Performs the conversion.

### `impl<T, U> Into for T where
U: From<T>,` [src]

#### `fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> Borrow for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut for T where
T: ?Sized,` [src]

####
ⓘImportant traits for &'_ mut I

### Important traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `fn get_type_id(&self) -> TypeId`[src]

🔬 This is a nightly-only experimental API. (`get_type_id` #27745)

this method will likely be replaced by an associated static

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

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse 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`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)