Struct Rx

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

Single consumer (receiver) that works in blocking context.

Additional methods can be accessed through Deref<Target=ChannelShared>.

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

Rx has Send marker, can be moved to other thread. 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 Sync marker, using Arc<Rx> will lose 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>

Receive message, will block when channel is empty.

Returns Ok(T) when successful.

Returns Err(RecvError) when all Tx dropped.

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

Try to receive message, non-blocking.

Returns Ok(T) when successful.

Returns Err(TryRecvError::Empty) when channel is empty.

returns Err(TryRecvError::Disconnected) when all Tx dropped and channel is empty.

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

Waits for a message to be received from the channel, but only for a limited time. Will block when channel is empty.

The behavior is atomic, either successfully polls a message, or operation cancelled due to 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) when all Tx dropped and channel is empty.

pub fn len(&self) -> usize

The number of messages in the channel at the moment

pub fn is_empty(&self) -> bool

Whether channel is empty at the moment

pub fn is_full(&self) -> bool

Whether the channel is full at the moment

Methods from Deref<Target = ChannelShared>

pub fn is_disconnected(&self) -> bool

Return true if all the senders or receivers are dropped

pub fn get_tx_count(&self) -> usize

Get the count of alive senders

pub fn get_rx_count(&self) -> usize

Get the count of alive receivers

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

Just for debugging purpose, to monitor queue size

Trait Implementations

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

fn as_ref(&self) -> &ChannelShared

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

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

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

Receive message, will block when channel is empty.

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

Try to receive message, non-blocking.

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

Waits for a message to be received from the channel, but only for a limited time. Will block when channel is empty.

fn len(&self) -> usize

The number of messages in the channel at the moment

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

The resulting type after dereferencing.

fn deref(&self) -> &ChannelShared

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: Send> Send for Rx<T>