Struct StateReceiveFuture

pub struct StateReceiveFuture<MutexType, T> { /* private fields */ }

A Future that is returned by the receive function on a state broadcast channel. The future gets resolved with Some((state_id, state)) when a value could be received from the channel.

state represents the new state which had been retrieved from the channel.

state_id is the StateId which can be passed as a parameter to receive() in order to fetch the next state from the channel.

If the channels gets closed and no items are still enqueued inside the channel, the future will resolve to None.

Trait Implementations

impl<MutexType, T> Debug for StateReceiveFuture<MutexType, T>

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

Formats the value using the given formatter.

impl<MutexType, T> Drop for StateReceiveFuture<MutexType, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<MutexType, T> FusedFuture for StateReceiveFuture<MutexType, T>

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

impl<MutexType, T> Future for StateReceiveFuture<MutexType, T>

type Output = Option<(StateId, T)>

The type of value produced on completion.

fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<(StateId, T)>>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<MutexType: Sync, T: Clone + Send> Send for StateReceiveFuture<MutexType, T>