Struct kernel::comms::kchannel::KConsumer

pub struct KConsumer<T> {
    q: HeapArc<MpScQueue<T, SpiteData<T>>>,
}

A Consumer for a KChannel.

Only a single KConsumer can exist at a time for each backing KChannel, as it is an MPSC queue. A KConsumer can also be used to create a new KProducer instance.

Fields

q: HeapArc<MpScQueue<T, SpiteData<T>>>

Implementations

impl<T> KConsumer<T>

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

Immediately returns the item in the front of the queue, or None if the queue is empty

pub async fn dequeue_async(&self) -> Result<T, DequeueError>

Await the availability of an item from the front of the queue.

If no item is available, this function will yield until an item has been enqueued

pub fn producer(&self) -> KProducer<T>

Create a KProducer for this KConsumer (and its backing KChannel).