Struct futures_intrusive::channel::shared::GenericReceiver

pub struct GenericReceiver<MutexType, T> where
    MutexType: RawMutex,
    T: 'static,  { /* fields omitted */ }

The receiving side of a channel which can be used to exchange values between concurrent tasks.

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.

Methods

impl<MutexType, T> GenericReceiver<MutexType, T> where
    MutexType: RawMutex + 'static, 

Important traits for ChannelReceiveFuture<T>

impl<T> Future for ChannelReceiveFuture<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 future send attempts will fail. Receive attempts will continue to succeed as long as there are items stored inside the channel. Further attempts will return None.

Trait Implementations

impl<MutexType: Send, T: Send> Send for GenericReceiver<MutexType, T> where
    MutexType: RawMutex + Send, 

impl<MutexType, T> Drop for GenericReceiver<MutexType, T> where
    MutexType: RawMutex, 

fn drop(&mut self)

Executes the destructor for this type.

impl<MutexType, T> Clone for GenericReceiver<MutexType, T> where
    MutexType: RawMutex, 

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<MutexType, T> Debug for GenericReceiver<MutexType, T> where
    MutexType: RawMutex, 

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

Formats the value using the given formatter.