Struct chan::Receiver

pub struct Receiver<T>(_);

The receiving half of a channel.

Receivers can be cloned any number of times and sent to other threads.

Receivers also implement Sync, which means they can be shared among threads without cloning if the channels can be proven to outlive the execution of the threads.

When all receiving halves of a channel are dropped, no special action is taken. If the buffer in the channel is full, all sends will block indefinitely.

Methods

impl<T> Receiver<T>

pub fn recv(&self) -> Option<T>

Receive a value on this channel.

If this is an asnychronous channel, recv only blocks when the buffer is empty.

If this is a synchronous channel, recv only blocks when the buffer is empty.

If this is a rendezvous channel, recv blocks until a corresponding send sends a value.

For all channels, if the channel is closed and the buffer is empty, then recv always and immediately returns None. (If the buffer is non-empty on a closed channel, then values from the buffer are returned.)

Values are guaranteed to be received in the same order that they are sent.

This operation will never panic! but it can deadlock if the channel is never closed.

Important traits for Iter<T>

impl<T> Iterator for Iter<T> type Item = T;

pub fn iter(&self) -> Iter<T>

Return an iterator for receiving values on this channel.

This iterator yields values (blocking if necessary) until the channel is closed.

Trait Implementations

impl<T> IntoIterator for Receiver<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<T>

Which kind of iterator are we turning this into?

Important traits for Iter<T>

impl<T> Iterator for Iter<T> type Item = T;

fn into_iter(self) -> Iter<T>

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Receiver<T>

type Item = T

The type of the elements being iterated over.

type IntoIter = Iter<T>

Which kind of iterator are we turning this into?

Important traits for Iter<T>

impl<T> Iterator for Iter<T> type Item = T;

fn into_iter(self) -> Iter<T>

Creates an iterator from a value.

impl<T: Debug> Debug for Receiver<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T> Clone for Receiver<T>

fn clone(&self) -> Receiver<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Drop for Receiver<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Hash for Receiver<T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T> PartialEq for Receiver<T>

fn eq(&self, other: &Receiver<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> Eq for Receiver<T>