Struct Rx 

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

A single consumer (receiver) that works in a blocking context.

Additional methods in ChannelShared can be accessed through Deref.

NOTE: Rx is not Clone or Sync. If you need concurrent access, use MRx instead.

Rx has a Send marker and can be moved to other threads. The following code is OK:

use crossfire::*;
let (tx, rx) = mpsc::bounded_blocking::<usize>(100);
std::thread::spawn(move || {
    let _ = rx.recv();
});
drop(tx);

Because Rx does not have a Sync marker, using Arc<Rx> will lose the Send marker.

For your safety, the following code should not compile:

use crossfire::*;
use std::sync::Arc;
let (tx, rx) = mpsc::bounded_blocking::<usize>(100);
let rx = Arc::new(rx);
std::thread::spawn(move || {
    let _ = rx.recv();
});
drop(tx);

Implementations

impl<T> Rx<T>

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

Receives a message from the channel. This method will block until a message is received or the channel is closed.

Returns Ok(T) on success.

Returns Err(RecvError) if the sender has been dropped.

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

Attempts to receive a message from the channel without blocking.

Returns Ok(T) when successful.

Returns Err(TryRecvError::Empty) if the channel is empty.

Returns Err(TryRecvError::Disconnected) if the sender has been dropped and the channel is empty.

pub fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError>

Receives a message from the channel with a timeout. Will block when channel is empty.

The behavior is atomic: the message is either received successfully or the operation is canceled due to a timeout.

Returns Ok(T) when successful.

Returns Err(RecvTimeoutError::Timeout) when a message could not be received because the channel is empty and the operation timed out.

Returns Err(RecvTimeoutError::Disconnected) if the sender has been dropped and the channel is empty.

Methods from Deref<Target = ChannelShared<T>>

pub fn len(&self) -> usize

The number of messages in the channel.

pub fn capacity(&self) -> Option<usize>

The capacity of the channel. Returns None for unbounded channels.

pub fn is_empty(&self) -> bool

Returns true if the channel is empty.

pub fn is_full(&self) -> bool

Returns true if the channel is full.

pub fn is_disconnected(&self) -> bool

Returns true if all senders or receivers have been dropped.

pub fn get_tx_count(&self) -> usize

Returns the number of senders for the channel.

pub fn get_rx_count(&self) -> usize

Returns the number of receivers for the channel.

pub fn get_wakers_count(&self) -> (usize, usize)

Returns the number of wakers for senders and receivers. For debugging purposes.

Trait Implementations

impl<T> AsRef<ChannelShared<T>> for Rx<T>

fn as_ref(&self) -> &ChannelShared<T>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Send + 'static> BlockingRxTrait<T> for Rx<T>

fn clone_to_vec(self, _count: usize) -> Vec<Self>

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

Receives a message from the channel. This method will block until a message is received or the channel is closed.

fn try_recv(&self) -> Result<T, TryRecvError>

Attempts to receive a message from the channel without blocking.

fn recv_timeout(&self, timeout: Duration) -> Result<T, RecvTimeoutError>

Receives a message from the channel with a timeout. Will block when channel is empty.

fn len(&self) -> usize

The number of messages in the channel at the moment

fn capacity(&self) -> Option<usize>

The capacity of the channel, return None for unbounded channel.

fn is_empty(&self) -> bool

Whether channel is empty at the moment

fn is_full(&self) -> bool

Whether the channel is full at the moment

fn is_disconnected(&self) -> bool

Return true if the other side has closed

impl<T> Debug for Rx<T>

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

Formats the value using the given formatter.

impl<T> Deref for Rx<T>

type Target = ChannelShared<T>

The resulting type after dereferencing.

fn deref(&self) -> &ChannelShared<T>

Dereferences the value.

impl<T> Display for Rx<T>

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

Formats the value using the given formatter.

impl<T> Drop for Rx<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<AsyncRx<T>> for Rx<T>

fn from(value: AsyncRx<T>) -> Self

Converts to this type from the input type.

impl<T> From<MRx<T>> for Rx<T>

fn from(rx: MRx<T>) -> Self

Converts to this type from the input type.

impl<T> From<Rx<T>> for AsyncRx<T>

fn from(value: Rx<T>) -> Self

Converts to this type from the input type.

impl<T: Send> Send for Rx<T>