Struct futures_intrusive::channel::shared::ChannelSendFuture

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

A Future that is returned by the send function on a channel. The future gets resolved with None when a value could be written to the channel. If the channel gets closed the send operation will fail, and the Future will resolve to ChannelSendError(T) and return the item to send.

Methods

impl<MutexType, T> ChannelSendFuture<MutexType, T>

pub fn cancel(&mut self) -> Option<T>

Tries to cancel the ongoing send operation

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

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

fn is_terminated(&self) -> bool

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

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

type Output = Result<(), ChannelSendError<T>>

The type of value produced on completion.

fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<(), ChannelSendError<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 ChannelSendFuture<MutexType, T>