Struct kernel::comms::oneshot::Reusable

pub struct Reusable<T> {
    inner: Arc<Inner<T>>,
}

A reusable One-Shot channel.

Essentially, a Reusable is a single producer, single consumer, channel, with a max depth of one. Many producers can be created over the lifecycle of a single consumer, however only zero or one producers can be live at any given time.

A Reusable<T> can be used to hand out single-use Sender items, which can be used to make a single reply.

A given Reusable<T> can only ever have zero or one Sender<T>s live at any given time, and a response can be received through a call to Reusable::receive.

Fields

inner: Arc<Inner<T>>

Implementations

impl<T> Reusable<T>

pub async fn new_async() -> Self

Create a new Reusable<T> using the heap from the given kernel

pub async fn sender(&self) -> Result<Sender<T>, ReusableError>

Create a sender for the given Reusable<T>. If a sender is already active, or the previous response has not yet been retrieved, an error will be immediately returned.

This error can be cleared by awaiting Reusable::receive.

pub async fn receive(&self) -> Result<T, ReusableError>

Await the response from a created sender.

If a sender has not been created, this function will immediately return an error.

If the sender is dropped without sending a response, this function will return an error after the sender has been dropped.

pub fn close(self)

Close the receiver. This will cause any pending senders to fail.

Trait Implementations

impl<T> Drop for Reusable<T>

fn drop(&mut self)

Executes the destructor for this type.