Struct FutureWrite

pub struct FutureWrite<T>
where
    T: 'static,
{ /* private fields */ }

Represents a write operation which may be cancelled prior to completion.

This is returned by FutureWriter::write.

Implementations

impl<T> FutureWrite<T>

where T: 'static,

pub fn cancel(self: Pin<&mut FutureWrite<T>>) -> FutureWriteCancel<T>

Cancel this write if it hasn’t already completed.

This method can be used to cancel a write-in-progress and re-acquire the writer and the value being sent. Note that the write operation may succeed racily or the other end may also drop racily, and these outcomes are reflected in the returned value here.

Panics

Panics if the operation has already been completed via Future::poll, or if this method is called twice.

Trait Implementations

impl<T> Future for FutureWrite<T>

where T: 'static,

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

The type of value produced on completion.

fn poll( self: Pin<&mut FutureWrite<T>>, cx: &mut Context<'_>, ) -> Poll<<FutureWrite<T> as Future>::Output>

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