Struct sync_channel::Receiver

pub struct Receiver<T: Send, P: DeadlockPrevention = Spin> { /* private fields */ }

The receiver side of a channel.

Implementations

impl<T: Send, P: DeadlockPrevention> Receiver<T, P>

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

Receive a message, blocking until a message is available in the buffer.

Returns the message if it was received properly, otherwise returns an Error.

pub fn receive_buf(&self, buf: &mut [T]) -> Result<usize, Error>

Receives objects placing them in a buffer and returning the number of objects received.

This method only blocks on the first object being received.

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

Tries to receive a message, only succeeding if a message is already available in the buffer.

If receive succeeds returns Some(Ok(T)). If an endpoint is disconnected returns Some(Err(ChannelStatus::Disconnected)). If no such message exists, it returns None without blocking

pub fn try_receive_buf(&self, buf: &mut [T]) -> Result<usize, Error>

Receives objects placing them in a buffer and returning the number of objects received.

This method does not block.

pub fn is_disconnected(&self) -> bool

Returns true if the channel is disconnected.

pub fn sender(&self) -> Sender<T, P>

Obtain a Sender endpoint connected to the same channel as this Receiver.

Trait Implementations

impl<T: Send, P: DeadlockPrevention> Clone for Receiver<T, P>

fn clone(&self) -> Self

Clones this Receiver, returning another Receiver connected to the same channel.

This increments the channel’s receiver count. If there were previously no receivers, the channel status is updated to Connected.

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

Performs copy-assignment from source.

impl<T: Send, P: DeadlockPrevention> Drop for Receiver<T, P>

When the only remaining Receiver is dropped, we mark the channel as disconnected and notify all of the Senders

fn drop(&mut self)

Executes the destructor for this type.