Struct MRx 

pub struct MRx<F: Flavor>(/* private fields */);

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

Inherits from Rx<F> and implements Clone. Additional methods can be accessed through Deref<Target=[ChannelShared]>.

You can use into() to convert it to Rx<F>.

Implementations

impl<F> MRx<F>

where F: FlavorMC + Flavor,

pub fn into_async(self) -> MAsyncRx<F>

Methods from Deref<Target = Rx<F>>

pub fn recv(&self) -> Result<F::Item, 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<F::Item, 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<F::Item, 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.

pub fn is_disconnected(&self) -> bool

Return true if the other side has closed

pub fn read_select(&self, result: SelectResult) -> Result<F::Item, RecvError>

where F: FlavorSelect,

This method use with select, guarantee non-blocking

Panics

Panics if SelectResult from other receiver is passed.

Methods from Deref<Target = ChannelShared<F>>

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 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<F: Flavor> AsRef<ChannelShared<F>> for MRx<F>

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

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

impl<F> BlockingRxTrait<<F as Queue>::Item> for MRx<F>

where F: Flavor + FlavorMC, F::Item: Send + 'static,

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

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

fn recv(&self) -> Result<F::Item, 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<F::Item, TryRecvError>

Attempts to receive a message from the channel without blocking.

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

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

fn get_tx_count(&self) -> usize

Return the number of senders

fn get_rx_count(&self) -> usize

Return the number of receivers

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

impl<F: Flavor> Clone for MRx<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Flavor> Debug for MRx<F>

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

Formats the value using the given formatter.

impl<F: Flavor> Deref for MRx<F>

fn deref(&self) -> &Self::Target

Inherits all the functions of Rx.

type Target = Rx<F>

The resulting type after dereferencing.

impl<F: Flavor> Display for MRx<F>

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

Formats the value using the given formatter.

impl<F: Flavor> From<MAsyncRx<F>> for MRx<F>

fn from(value: MAsyncRx<F>) -> Self

Converts to this type from the input type.

impl<F: Flavor> From<MRx<F>> for MAsyncRx<F>

fn from(value: MRx<F>) -> Self

Converts to this type from the input type.

impl<F: Flavor> From<MRx<F>> for Rx<F>

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

Converts to this type from the input type.

impl<F> ReceiverType for MRx<F>

where F: Flavor + FlavorMC, F::Item: Send + 'static,

type Flavor = F

fn new(shared: Arc<ChannelShared<F>>) -> Self

impl<F: Flavor> Sync for MRx<F>