Struct futures_intrusive::channel::GenericChannel

pub struct GenericChannel<MutexType: RawMutex, T, A> where
    A: RingBuf<Item = T>,  { /* fields omitted */ }

A channel which can be used to exchange values of type T between concurrent tasks.

A represents the backing buffer for a Channel. E.g. a channel which can buffer up to 4 u32 values can be created via:

let channel: LocalChannel<i32, [i32; 4]> = LocalChannel::new();

Tasks can receive values from the channel through the receive method. The returned Future will get resolved when a value is sent into the channel. Values can be sent into the channel through send. The returned Future will get resolved when the value has been stored inside the channel.

Methods

impl<MutexType: RawMutex, T, A> GenericChannel<MutexType, T, A> where
    A: RingBuf<Item = T>, 

pub fn new() -> Self

Creates a new Channel, utilizing the default capacity that the RingBuffer in A provides.

pub fn with_capacity(capacity: usize) -> Self

Creates a new Channel, which has storage for a capacity items. Depending on the utilized RingBuf type, the capacity argument might be ignored and the default capacity might be utilized.

Important traits for ChannelSendFuture<'a, T>

impl<'a, T> Future for ChannelSendFuture<'a, T> type Output = Result<(), ChannelSendError<T>>;

pub fn send(&self, value: T) -> ChannelSendFuture<T>

Returns a future that gets fulfilled when the value has been written to the channel. If the channel gets closed while the send is in progress, sending the value will fail, and the future will deliver the value back.

Important traits for ChannelReceiveFuture<'a, T>

impl<'a, T> Future for ChannelReceiveFuture<'a, T> type Output = Option<T>;

pub fn receive(&self) -> ChannelReceiveFuture<T>

Returns a future that gets fulfilled when a value is written to the channel. If the channels gets closed, the future will resolve to None.

pub fn close(&self)

Closes the channel. All pending and future send attempts will fail. Receive attempts will continue to succeed as long as there are items stored inside the channel. Further attempts will fail.

Trait Implementations

impl<MutexType: RawMutex + Send, T: Send, A> Send for GenericChannel<MutexType, T, A> where
    A: RingBuf<Item = T> + Send, 

impl<MutexType: RawMutex, T, A> Debug for GenericChannel<MutexType, T, A> where
    A: RingBuf<Item = T>, 

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.