Struct scoped_stream_sink::StreamInner

pub struct StreamInner<'scope, 'env: 'scope, T> { /* private fields */ }

Inner type of ScopedStream.

Implements Sink to send data for the stream.

Note About Thread-safety

Even though StreamInner is both Send and Sink, it’s reference should not be sent across thread. This is currently impossible, due to lack of async version of scope. To future-proof that possibility, any usage of it will panic if called from different thread than the outer thread. It also may panics outer thread too.

Also do note that some of the check depends on debug_assertions build config (AKA only on debug builds).

Trait Implementations

impl<'scope, 'env: 'scope, T> Sink<T> for StreamInner<'scope, 'env, T>

type Error = Infallible

The type of value produced by the sink when an error occurs.

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn poll_flush( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_close( self: Pin<&mut Self>, _cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl<'__pin, 'scope, 'env: 'scope, T> Unpin for StreamInner<'scope, 'env, T>

where __Origin<'__pin, 'scope, 'env, T>: Unpin,