Struct StreamRead

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

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

Implementations

impl<'a, T> StreamRead<'a, T>

pub fn cancel(self: Pin<&mut StreamRead<'a, T>>) -> (StreamResult, Vec<T>)

Cancel this read if it hasn’t already completed.

This method will initiate a cancellation operation for this active read. This may race with the actual read itself and so this may actually complete with some results.

The final result of cancellation is returned, along with the original buffer.

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 StreamRead<'_, T>

where T: 'static,

type Output = (StreamResult, Vec<T>)

The type of value produced on completion.

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