Struct FutureRead

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

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

This represents a read operation on a FutureReader and is created via IntoFuture.

Implementations

impl<T> FutureRead<T>

pub fn cancel( self: Pin<&mut FutureRead<T>>, ) -> Result<Option<T>, FutureReader<T>>

Cancel this read if it hasn’t already completed.

Return values include:

• Ok(Some(value)) - future completed before this cancellation request was received.
• Ok(None) - future closed before this cancellation request was received.
• Err(reader) - read operation was cancelled and it can be retried in the future if desired.

Note that if this method is called after the write was already cancelled then Ok(None) will be returned.

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 FutureRead<T>

where T: 'static,

type Output = Option<T>

The type of value produced on completion.

fn poll( self: Pin<&mut FutureRead<T>>, cx: &mut Context<'_>, ) -> Poll<<FutureRead<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.