Struct futures_intrusive::channel::shared::ChannelReceiveFuture

#[must_use = "futures do nothing unless polled"]
pub struct ChannelReceiveFuture<MutexType, T> { /* fields omitted */ }

A Future that is returned by the receive function on a channel. The future gets resolved with Some(value) when a value could be received 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 ChannelReceiveFuture<MutexType, T>

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn is_terminated(&self) -> bool

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

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

type Output = Option<T>

The type of value produced on completion.

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

Attempt 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: Send> Send for ChannelReceiveFuture<MutexType, T>