Struct BufReader 

pub struct BufReader<S: AsRef<[u8]>> { /* private fields */ }

A buffered reader for byte slices that tracks the current read position.

Wraps any type implementing [AsRef<[u8]>] and provides seeking and reading operations while maintaining an internal cursor position.

See BufReader::from_slice for construction.

Implementations

impl<S> BufReader<S>

where S: AsRef<[u8]>,

pub fn from_slice(s: S) -> Self

Creates a new BufReader wrapping the provided byte slice.

The reader’s position is initialized to 0.

Examples

use pure_magic::readers::{BufReader, DataRead};

let reader = BufReader::from_slice(b"hello world");
assert_eq!(reader.stream_position(), 0);

Trait Implementations

impl<S> DataRead for BufReader<S>

where S: AsRef<[u8]>,

fn stream_position(&self) -> u64

Returns the current position in the data stream.

fn read_range(&mut self, range: Range<u64>) -> Result<&[u8]>

Reads a range of bytes from the data.

fn read_until_any_delim_or_limit( &mut self, delims: &[u8], limit: u64, ) -> Result<&[u8], Error>

Reads bytes until any of the delimiters or limit bytes is reached.

fn read_until_or_limit(&mut self, byte: u8, limit: u64) -> Result<&[u8], Error>

Reads bytes until byte or limit bytes is reached.

fn read_while_or_limit<F>(&mut self, f: F, limit: u64) -> Result<&[u8], Error>

where F: Fn(u8) -> bool,

Reads bytes while f returns true or until limit bytes is reached.

fn read_until_utf16_or_limit( &mut self, utf16_char: &[u8; 2], limit: u64, ) -> Result<&[u8], Error>

Reads bytes until a UTF-16 character or limit bytes is reached.

fn data_size(&self) -> u64

Returns the total size of the data in bytes.

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

Sets the position for future reads.

fn offset_from_start(&self, pos: SeekFrom) -> u64

Computes the absolute byte offset from a SeekFrom position.

fn read_count(&mut self, count: u64) -> Result<&[u8], Error>

Reads up to count bytes from the current position.

fn read_exact_range(&mut self, range: Range<u64>) -> Result<&[u8], Error>

Reads exactly the specified byte range.

fn read_exact_count(&mut self, count: u64) -> Result<&[u8], Error>

Reads exactly count bytes from the current position.

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

Reads exactly enough bytes to fill buf.

impl<S> Read for BufReader<S>

where S: AsRef<[u8]>,

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<'_>) -> 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)

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.