Struct Receiver 

pub struct Receiver<C, T>
where
    C: Controller<Item = T>,
{ /* private fields */ }

Channel receiver end-point.

Implementations

impl<C, T> Receiver<C, T>

where C: Controller<Item = T>,

pub fn ctrl(&self) -> Ctrl<C, T>

Return a Ctrl, which can be used to access the internal Controller.

pub fn recv_blocking(&self) -> Result<T, Error<T>>

Receive a node from queue. If the queue is empty, block and wait for a new node to arrive.

Errors

Error::Closed means that the queue is empty and all the Senders have been dropped.

pub fn recv_async(&self) -> RecvFuture<C, T>

Returns a Future that is the async equivalent of Receiver::recv_blocking().

pub fn try_recv(&self) -> Result<Option<T>, Error<T>>

Attempt to retreive a node from the queue.

Returns Ok(Some(T)) if there’s a node available for immediate pickup. Returns Ok(None) is there are no nodes to pick up.

Errors

Error::Closed means that the queue is empty and all the Senders have been dropped.

Trait Implementations

impl<C, T> Clone for Receiver<C, T>

where C: Controller<Item = T>,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C, T> Drop for Receiver<C, T>

where C: Controller<Item = T>,

fn drop(&mut self)

Executes the destructor for this type.