Struct Channel 

struct Channel<T> {
    state: Mutex<State<T>>,
    capacity: usize,
    readable: Notify,
    writable: Notify,
    closed: Notify,
}

The state shared by the senders and receivers of a channel.

Fields

state: Mutex<State<T>>

capacity: usize

readable: Notify

Wakes the receivers once a message got queued into an empty channel, or the channel got closed. A receiver waits only while the channel is empty, so the other messages need no wake-up. That makes it wake all waiters, the messages queued before they ran are for them as well.

writable: Notify

Wakes the senders once a message got taken from a full channel, or the channel got closed. A sender waits only while the channel is full, all waiters get woken, see readable.

closed: Notify

Wakes Sender::closed once the channel got closed, which a busy channel would wake up for every message otherwise.

Implementations

impl<T> Channel<T>

fn push(&self, message: T, force: bool) -> Result<(), Push<T>>

Queue a message. A full channel fails, or drops its oldest message with force.

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

Take the oldest message.

fn wake_all(&self)

Wake everything which waits, after the channel got closed.