Struct StreamWrite

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

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

Implementations

impl<'a, T> StreamWrite<'a, T>

where T: 'static,

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

Cancel this write if it hasn’t already completed.

This method can be used to cancel a write-in-progress and re-acquire values being sent. Note that the result here may still indicate that some values were written if the race to cancel the write was lost.

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

where T: 'static,

type Output = (StreamResult, AbiBuffer<T>)

The type of value produced on completion.

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