Struct futures_intrusive::channel::shared::GenericStateReceiver

pub struct GenericStateReceiver<MutexType, T> where
    MutexType: RawMutex,
    T: Clone + '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> GenericStateReceiver<MutexType, T> where
    MutexType: RawMutex + 'static,
    T: Clone, 

pub fn receive(&self, state_id: StateId) -> StateReceiveFuture<MutexType, T>

Returns a future that gets fulfilled when a value is written to the channel or the channel is closed. state_id specifies the minimum state ID that should be retrieved by the receive operation.

The returned StateReceiveFuture will get fulfilled with the retrieved value as well as the StateId which is required to retrieve the following state

pub fn try_receive(&self, state_id: StateId) -> Option<(StateId, T)>

Attempt to retrieve a value whose StateId is greater than the one provided.

Returns None if no value is found in the channel, or if the current StateId of the value is less or equal to the one provided.

Trait Implementations

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

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 GenericStateReceiver<MutexType, T> where
    MutexType: RawMutex,
    T: Clone, 

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

Formats the value using the given formatter.

impl<MutexType, T> Drop for GenericStateReceiver<MutexType, T> where
    MutexType: RawMutex,
    T: Clone, 

fn drop(&mut self)

Executes the destructor for this type.