Struct tokio::io::StreamReader

[+] Show declaration

pub struct StreamReader<S, B> { /* fields omitted */ }

[−] Expand description

Convert a stream of byte chunks into an AsyncRead.

This type is usually created using the stream_reader function.

Trait Implementations

impl<S, B> AsyncBufRead for StreamReader<S, B> where
    S: Stream<Item = Result<B, Error>>,
    B: Buf, [+]

[+] Show hidden undocumented items

fn poll_fill_buf(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<&[u8]>>[−]

Attempts to return the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(self: Pin<&mut Self>, amt: usize)[−]

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to [poll_read].

impl<S, B> AsyncRead for StreamReader<S, B> where
    S: Stream<Item = Result<B, Error>>,
    B: Buf, [+]

[+] Show hidden undocumented items

fn poll_read(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut [u8]
) -> Poll<Result<usize>>[−]

Attempts to read from the AsyncRead into buf.

fn poll_read_buf<BM: BufMut>(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>,
    buf: &mut BM
) -> Poll<Result<usize>> where
    Self: Sized, [−]

Pulls some bytes from this source into the specified BufMut, returning how many bytes were read.

unsafe fn prepare_uninitialized_buffer(
    &self,
    _buf: &mut [MaybeUninit<u8>]
) -> bool[−]

Prepares an uninitialized buffer to be safe to pass to read. Returns true if the supplied buffer was zeroed out.

impl<S: Debug, B: Debug> Debug for StreamReader<S, B>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'__pin, S, B> Unpin for StreamReader<S, B> where
    __Origin<'__pin, S, B>: Unpin,