Struct tokio::io::ReaderStream

pub struct ReaderStream<R> { /* fields omitted */ }

Convert an AsyncRead implementor into a Stream of Result<Bytes, std::io::Error>. After first error it will stop. Additionally, this stream is fused: after it returns None at some moment, it is guaranteed that further next(), poll_next() and similar functions will instantly return None.

This type can be created using the reader_stream function

Trait Implementations

impl<R: Debug> Debug for ReaderStream<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<R> Stream for ReaderStream<R> where
    R: AsyncRead, 

type Item = Result<Bytes>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

pub fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<'__pin, R> Unpin for ReaderStream<R> where
    __Origin<'__pin, R>: Unpin,