Struct MultiplexerChannel 

pub struct MultiplexerChannel<T>
where
    T: Clone + Send + Sync + 'static,
{
    pub id: Id,
    pub sender: Sender<T>,
    pub receiver: Receiver<T>,
    /* private fields */
}

Receiving channel endpoint for the Multiplexer. MultiplexerChannel<T> holds a Sender and the Receiver channel endpoints. The Sender is provided for convenience, allowing internal relay within this channel instance. To process events, simply iterate over MultiplexerChannel::recv() by calling channel.recv().await.

Fields

id: Id

Unique id identifying this channel within the parent Multiplexer.

sender: Sender<T>

Sender endpoint, provided for convenient internal relay within this channel.

receiver: Receiver<T>

Receiver endpoint from which broadcast events are consumed.

Implementations

impl<T> MultiplexerChannel<T>

where T: Clone + Send + Sync + 'static,

pub fn close(&self)

Close the receiving channel. This will unregister the channel from the Multiplexer.

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

Receive an event from the channel. This is a blocking async call.

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

Receive an event from the channel. This is a non-blocking sync call that follows Receiver::try_recv semantics.

Trait Implementations

impl<T> Clone for MultiplexerChannel<T>

where T: Clone + Send + Sync + 'static,

fn clone(&self) -> MultiplexerChannel<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Drop for MultiplexerChannel<T>

where T: Clone + Send + Sync + 'static,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> From<&Multiplexer<T>> for MultiplexerChannel<T>

where T: Clone + Send + Sync + 'static,

Create a MultiplexerChannel from Multiplexer by reference.

fn from(multiplexer: &Multiplexer<T>) -> MultiplexerChannel<T>

Converts to this type from the input type.