[src]

Struct std::comm::Handle

pub struct Handle<'rx, T> {
    // some fields omitted
}

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>

fn id(&self) -> uint

Retrieve the id of this handle.

fn recv(&mut self) -> T

Receive a value on the underlying receiver. Has the same semantics as Receiver.recv

fn recv_opt(&mut self) -> Option<T>

Block 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_opt

unsafe fn add(&mut self)

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)

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>

fn drop(&mut self)

The drop method, called when the value goes out of scope.