Struct Receiver

pub struct Receiver<T> { /* private fields */ }

Implementations

impl<T> Receiver<T>

pub const fn from_inner(inner: Arc<Mutex<Receiver<T>>>) -> Self

impl<T> Receiver<T>

pub fn from_inner_mutex(mutex: Mutex<Receiver<T>>) -> Self

impl<T> Receiver<T>

pub fn from_inner_recv(receiver: Receiver<T>) -> Self

impl<T> Receiver<T>

pub fn recv(&self) -> Result<T, RecvError>

Blocks the current thread until a message is received or the channel is disconnected.

Blocking

• If no message is ready and at least one Sender still exists, execution is suspended until either
  • a message is sent, or
  • every Sender is dropped.

Buffered

• Messages sent before the last Sender is dropped are still delivered.

Errors

Once all senders are gone, and all buffered messages are consumed, all subsequent calls return RecvError.

Safety

Channels are prone to deadlocks. You shall ensure a message will be sent via a corresponding Sender, or that all corresponding Senders will be dropped.

Examples

use ps_mpmc::channel;

let (tx, rx) = channel::<i32>().into_parts();

std::thread::spawn(move || { tx.send(42).unwrap(); });

assert_eq!(rx.recv(), Ok(42));
assert_eq!(rx.recv(), Err(std::sync::mpsc::RecvError));

See also std::sync::mpsc::Receiver::recv for details of the underlying implementation.

Trait Implementations

impl<T> Clone for Receiver<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.