Struct StreamReader

pub struct StreamReader { /* private fields */ }

Provides linear read access to a BufferedFile.

The StreamReader implements AsyncRead and AsyncBufRead, which can offer the user with a convenient way of issuing reads. However, note that this mandates a copy between the OS page cache and an intermediary buffer before it reaches the user-specified buffer

Implementations

impl StreamReader

pub async fn close(self) -> Result<(), ()>

Asynchronously closes the underlying file.

Trait Implementations

impl AsyncBufRead for StreamReader

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

Attempt 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 AsyncRead for StreamReader

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

Attempt to read from the AsyncRead into buf.

fn poll_read_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &mut [IoSliceMut<'_>], ) -> Poll<Result<usize, Error>>

Attempt to read from the AsyncRead into bufs using vectored IO operations.

impl AsyncSeek for StreamReader

fn poll_seek( self: Pin<&mut Self>, cx: &mut Context<'_>, pos: SeekFrom, ) -> Poll<Result<u64>>

Attempt to seek to an offset, in bytes, in a stream.

impl Debug for StreamReader

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

Formats the value using the given formatter.

impl<'__pin> Unpin for StreamReader

where PinnedFieldsOf<__Origin<'__pin>>: Unpin,