Struct binrw::io::BufReader

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

Available on crate feature std only.

A wrapper to add buffering to a read stream.

Unlike std::io::BufReader, this wrapper does not invalidate the read buffer every time a Seek method is called. It also caches the underlying stream position to avoid unnecessary system calls.

Limitations

Reading or seeking the wrapped stream object directly will cause an inconsistency in the internal state of the BufReader. Calling BufReader::seek_invalidate will clear the read buffer and reset the internal state to be consistent with the wrapped stream.

Implementations

impl<T: Read> BufReader<T>

pub fn new(inner: T) -> BufReader<T>

Creates a new BufReader<T> with a default buffer capacity.

pub fn with_capacity(capacity: usize, inner: T) -> BufReader<T>

Creates a new BufReader<T> with the specified buffer capacity.

impl<T> BufReader<T>

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

Returns a reference to the internally buffered data.

pub fn capacity(&self) -> usize

Returns the number of bytes the internal buffer can hold at once.

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

Gets a mutable reference to the underlying reader.

It is inadvisable to directly read from the underlying reader as it will, at the least, break the cached position information.

pub fn get_ref(&self) -> &T

Gets a reference to the underlying reader.

pub fn into_inner(self) -> T

Unwraps this BufReader<T>, returning the underlying reader.

Note that any leftover data in the internal buffer is lost. Therefore, a following read from the underlying reader may lead to data loss.

impl<T: Seek> BufReader<T>

pub fn seek_invalidate(&mut self, pos: SeekFrom) -> Result<u64>

Performs a seek that forces invalidation of the buffer and internal position state.

Errors

Returns an error if seeking fails.

Trait Implementations

impl<T: Read> BufRead for BufReader<T>

fn fill_buf(&mut self) -> Result<&[u8]>

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

fn consume(&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 read.

fn has_data_left(&mut self) -> Result<bool, Error>

🔬This is a nightly-only experimental API. (buf_read_has_data_left)

Check if the underlying Read has any data left to be read.

fn read_until( &mut self, byte: u8, buf: &mut Vec<u8, Global> ) -> Result<usize, Error>

Read all bytes into buf until the delimiter byte or EOF is reached.

fn read_line(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided String buffer.

fn split(self, byte: u8) -> Split<Self>where Self: Sized,

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>where Self: Sized,

Returns an iterator over the lines of this reader.

impl<T: Read> Read for BufReader<T>

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>

Like read, except that it reads into a slice of buffers.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

Read all bytes until EOF in this source, appending them to buf.

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

Read the exact number of bytes required to fill buf.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Selfwhere Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self> where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self> where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<T: Seek> Seek for BufReader<T>

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.

fn stream_position(&mut self) -> Result<u64>

Returns the current seek position from the start of the stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).