Struct std::io::BufferedReader

A buffered wrapper over an underlying stream.

Fields

• inner: &mut R

• buf: &mut [u8]

• pos: usize

• cap: usize

Methods

• fn new(inner: &mut R, buf_size: usize) -> BufferedReader<R>

  source

  Create a BufferedReader with a heap-allocated buffer of the given size.

• fn from_slice(inner: &mut R, buf: &mut [u8]) -> BufferedReader<R>

  source

  Creates a BufferedReader from an existing-buffer, potentially avoiding a heap allocation.

• fn fill_buffer(self: &mut BufferedReader<R>) -> Result<&[u8]>

  source

  Return the current contents of the buffer, reading additional data from the stream if necessary.

  Does not move the internal buffer position.

• fn consume(self: &mut BufferedReader<R>, amount: usize)

  source

  Mark amount bytes as consumed, moving the internal buffer position forward.

• fn read(self: &mut BufferedReader<R>, buf: &mut [u8]) -> Result<usize>

  source

  Reads from the stream into a provided buffer.

  If successful, returns the number of bytes read. This may be less than the size of the provided buffer.

• fn read_exact(self: &mut BufferedReader<R>, buf: &mut [u8]) -> Result<()>

  source

  Fills the provided buffer by reading from the stream.

  If stream had less bytes available than the size of the buffer, this method will return an Error::eof().

• fn free(self: &mut BufferedReader<R>)

  source

  Frees the memory backing the object.

• fn move(self: &mut BufferedReader<R>) -> BufferedReader<R>

  source

  Creates a copy of the object, leaving an inert object behind.

  See Movable for details.

• fn seek(self: &mut BufferedReader<R>, whence: SeekFrom, offset: i64) -> Result<u64>

  source

  Jump to a specified position in the stream.

  Returns the new position in the stream from the beginning.

Mixins

• mixin Readable<BufferedReader<R>>

• fn read_to_end(self: &mut Self, buf: &mut StringBuf) -> Result<usize>

  source

  Reads the entire stream into a StringBuf.

  If successful, returns the number of bytes that were read.

• mixin Seekable<BufferedReader<R>>

• fn rewind(self: &mut Self) -> Result<()>

  source

  Rewind the stream to the beginning.

• fn position(self: &mut Self) -> Result<u64>

  source

  Returns the current position in the stream from the beginning.