Struct kernel::comms::kchannel::KChannel

pub struct KChannel<T> {
    q: Arc<MpScQueue<T, SpiteData<T>>>,
}

A Kernel Channel

Fields

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

Implementations

impl<T> KChannel<T>

pub async fn new_async(count: usize) -> Self

Create a new KChannel<T> with room for count elements on the given Kernel’s allocator.

count should be a power of two >= 2, or the capacity will be increased automatically.

pub fn new(count: usize) -> Self

Create a new KChannel<T> with room for count elements on the given Kernel’s allocator. Used for pre-async initialization steps

count should be a power of two >= 2, or the capacity will be increased automatically.

pub fn split(self) -> (KProducer<T>, KConsumer<T>)

Split the KChannel into a pair of KProducer and KConsumer.

pub fn into_consumer(self) -> KConsumer<T>

Convert the KChannel directly into a KConsumer

Because a KConsumer can be used to create a KProducer, this method is handy when the producer is not immediately needed.

Methods from Deref<Target = MpScQueue<T, SpiteData<T>>>

pub fn close(&self)

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

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

pub fn enqueue_sync(&self, item: T) -> Result<(), EnqueueError<T>>

Adds an item to the end of the queue

Returns back the item if the queue is full

pub async fn enqueue_async(&self, item: T) -> Result<(), EnqueueError<T>>

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

Trait Implementations

impl<T> Clone for KChannel<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Deref for KChannel<T>

type Target = MpScQueue<T, SpiteData<T>>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.