Struct BufReader 

pub struct BufReader<R> { /* private fields */ }

A reader with a buffer in front: small reads take from the buffer, which is filled by large reads of the reader. Writes, if the reader is also a writer, go straight through.

Implementations

impl<R> BufReader<R>

pub fn new(inner: R) -> Self

A reader with a buffer of 8 KiB in front of inner.

pub fn with_capacity(capacity: usize, inner: R) -> Self

A reader with a buffer of capacity bytes in front of inner.

pub fn get_ref(&self) -> &R

The reader inside.

pub fn get_mut(&mut self) -> &mut R

The reader inside, to change (reading it directly skips the bytes buffered).

pub fn get_pin_mut(self: Pin<&mut Self>) -> Pin<&mut R>

where R: Unpin,

The reader inside, pinned.

pub fn into_inner(self) -> R

The reader inside, taken back; the bytes buffered are lost.

pub fn buffer(&self) -> &[u8]

The bytes buffered and not read yet.

Trait Implementations

impl<R: AsyncRead + Unpin> AsyncBufRead for BufReader<R>

fn poll_fill_buf( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<&[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>, amount: 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<R: AsyncRead + Unpin> AsyncRead for BufReader<R>

fn poll_read( self: Pin<&mut Self>, cx: &mut Context<'_>, out: &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<R: AsyncRead + AsyncSeek + Unpin> AsyncSeek for BufReader<R>

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

Seeks the reader; a seek relative to the current position counts from the position of the next byte read through the buffer. The buffer is emptied.

impl<R: AsyncWrite + Unpin> AsyncWrite for BufReader<R>

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

Attempt to write bytes from buf into the object.

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

Attempt to write bytes from bufs into the object using vectored IO operations.

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

Attempt to flush the object, ensuring that any buffered data reach their destination.

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

Attempt to close the object.

impl<R: Debug> Debug for BufReader<R>

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

Formats the value using the given formatter.