Struct BufferedReader 

pub struct BufferedReader<'a, const N: usize> { /* private fields */ }

read a file a large buffer at a time and provide access to a slice in that buffer

Implementations

impl<'a, const N: usize> BufferedReader<'a, N>

pub const fn new() -> Self

pub fn with_file(self, file: &'a File, read_limit: FileSize) -> Self

pub fn rebind<'b>(self) -> Result<BufferedReader<'b, N>>

Reset to idle state and re-type with a fresh lifetime 'b.

Trait Implementations

impl<const N: usize> BufRead for BufferedReader<'_, N>

BufferedReader implements a more permissive API compared to BufRead by allowing consume to advance beyond the end of the buffer returned by fill_buf.

fn consume(&mut self, amt: usize)

Advance the buffer position by amt, clamped to the end of the currently buffered data.

This follows the standard BufRead::consume contract: amt must not exceed the buffer length returned by the preceding fill_buf. To skip bytes beyond the current buffer, use FileBufRead::consume_or_skip instead.

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

Returns the contents of the internal buffer, filling it with more data, via Read methods, if empty.

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

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

Checks if there is any data left to be read.

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

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

fn skip_until(&mut self, byte: u8) -> Result<usize, Error>

Skips all bytes until the delimiter byte or EOF is reached.

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

Reads 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<'a, const N: usize> FileBufRead<'a> for BufferedReader<'a, N>

fn add_file_to_prefetch( &mut self, _file: &'a File, _read_limit: FileSize, ) -> Result<()>

BufferedReader does not perform read-ahead — the call is a no-op and the file becomes active only when set_file is later invoked.

fn set_file(&mut self, file: &'a File, read_limit: FileSize) -> Result<()>

Activate the given file as source of reads of this reader.

fn get_file_offset(&self) -> FileSize

Returns the current file offset corresponding to the start of the buffer that will be returned by the next call to fill_buf.

fn consume_or_skip(&mut self, amt: usize)

Advance the offset by amt bytes, potentially skipping past the current buffer into the underlying file.

impl<const N: usize> Read for BufferedReader<'_, N>

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, Error>

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

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_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_, u8>) -> 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<'_, u8>, ) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter 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.

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

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

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in little-endian order.

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

where T: FromEndianBytes, Self: Sized,

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

Read and return a type (e.g. an integer) in big-endian order.

impl<const N: usize> RequiredLenBufRead for BufferedReader<'_, N>

Supported required_len is limited by backing buffer size without ability to grow.

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

Ensures the internal buffer contains at least required_len contiguous bytes, and returns a slice of that buffer.