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

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

: 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`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>

fn id(&self) -> usize

Unstable

: 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>

Unstable

: 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`Someon success or` on success or None`Noneif the channel disconnects. This function has the same semantics as` if the channel disconnects. This function has the same semantics as Receiver.recv`Receiver.recv`

unsafe fn add(&mut self)

Unstable

: 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`add` was called previously.

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

unsafe fn remove(&mut self)

Unstable

: 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`Selectset. This method is unsafe because it has no guarantee that the` set. This method is unsafe because it has no guarantee that the Handle`Handlewas not moved since` was not moved since add`add` was called.

Trait Implementations

impl<'rx, T: Send> Drop for Handle<'rx, T>

fn drop(&mut self)