Struct ThreadChannel 

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

A bidirectional thread channel that combines both sender and receiver.

This is useful when you need both send and receive capabilities in one place.

Implementations

impl<T> ThreadChannel<T>

pub fn unbounded() -> (ThreadSender<T>, ThreadReceiver<T>)

Create a new unbounded thread channel.

An unbounded channel has no capacity limit and will never block on send.

Returns

A tuple of (sender, receiver) for the channel.

pub fn bounded(capacity: usize) -> (ThreadSender<T>, ThreadReceiver<T>)

Create a new bounded thread channel with the specified capacity.

A bounded channel will block on send when the channel is full.

Arguments

• capacity - The maximum number of messages the channel can hold.

Returns

A tuple of (sender, receiver) for the channel.

pub fn new_unbounded() -> Self

Create a new bidirectional thread channel (unbounded).

pub fn new_bounded(capacity: usize) -> Self

Create a new bidirectional thread channel (bounded).

pub fn sender(&self) -> &ThreadSender<T>

Get a reference to the sender.

pub fn receiver(&self) -> &ThreadReceiver<T>

Get a reference to the receiver.

pub fn clone_sender(&self) -> ThreadSender<T>

Clone the sender.

pub fn clone_receiver(&self) -> ThreadReceiver<T>

Clone the receiver.

pub fn split(self) -> (ThreadSender<T>, ThreadReceiver<T>)

Split the channel into sender and receiver.

Trait Implementations

impl<T: Debug> Debug for ThreadChannel<T>

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

Formats the value using the given formatter.

impl<T> GracefulChannel for ThreadChannel<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