Struct Channel

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

An asynchronous multi-producer multi-consumer channel based on tokio::sync::Notify.

Implementations

impl<T> Channel<T>

pub fn new() -> Self

Create a new instance of Channel.

pub fn close(&self)

Close the channel.

pub fn send(&self, msg: T) -> Result<(), T>

Send a message to the channel.

The message object will be returned on error, to ease the lifecycle management.

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

Try to receive a message from the channel.

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

Receive message from the channel in asynchronous mode.

pub fn flush_pending_prefetch_requests<F>(&self, f: F)

where F: FnMut(&T) -> bool,

Flush all pending requests specified by the predicator.

pub fn lock_channel(&self) -> MutexGuard<'_, VecDeque<T>>

Lock the channel to block all queue operations.

pub fn notify_waiters(&self)

Notify all waiters.

Trait Implementations

impl<T> Default for Channel<T>

fn default() -> Self

Returns the “default value” for a type.