Struct ThreadReceiver 

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

A thread-safe channel receiver for intra-process communication.

This is the receiving half of a ThreadChannel. It can be cloned to create multiple consumers that receive from the same channel.

Implementations

impl<T> ThreadReceiver<T>

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

Receive a message from the channel.

This method blocks until a message is available.

Errors

Returns IpcError::Closed if the channel has been shutdown or all senders have been dropped.

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

Try to receive a message without blocking.

Errors

• IpcError::Closed if the channel has been shutdown or all senders have been dropped.
• IpcError::WouldBlock if no message is available.

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

Receive a message with a timeout.

Errors

• IpcError::Closed if the channel has been shutdown or all senders have been dropped.
• IpcError::Timeout if the timeout expires before a message is available.

pub fn is_empty(&self) -> bool

Check if the channel is empty.

pub fn len(&self) -> usize

Get the number of messages in the channel.

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

Get the capacity of the channel (None for unbounded channels).

pub fn is_shutdown(&self) -> bool

Check if the channel has been shutdown.

pub fn shutdown(&self)

Shutdown the channel.

pub fn iter(&self) -> impl Iterator<Item = T> + '_

Create an iterator over received messages.

The iterator will block waiting for messages and will stop when the channel is closed.

pub fn try_iter(&self) -> impl Iterator<Item = T> + '_

Create a non-blocking iterator over available messages.

The iterator will return None when no more messages are immediately available.

Trait Implementations

impl<T> Clone for ThreadReceiver<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 ThreadReceiver<T>

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

Formats the value using the given formatter.

impl<T> GracefulChannel for ThreadReceiver<T>

fn shutdown(&self)

Signal the channel to shutdown

fn is_shutdown(&self) -> bool

Check if the channel has been signaled to shutdown

fn drain(&self) -> Result<()>

Wait for all pending messages to be processed

fn shutdown_timeout(&self, timeout: Duration) -> Result<()>

Shutdown with a timeout