Struct BufReader

pub struct BufReader<'a> { /* private fields */ }

Available on crate feature dep_symphonia only.

A BufReader reads bytes from a byte buffer.

Implementations

impl<'a> BufReader<'a>

pub fn new(buf: &'a [u8]) -> BufReader<'a>

Instantiate a new BufReader with a given byte buffer.

pub fn scan_bytes_ref( &mut self, pattern: &[u8], scan_len: usize, ) -> Result<&'a [u8], Error>

Scans up-to scan_len bytes from the stream until a byte pattern is matched. A reference to scanned bytes including the matched pattern are returned. If scan_len bytes are scanned without matching the pattern, a reference to the scanned bytes are also returned. Likewise, if the underlying buffer is exhausted before matching the pattern, remainder of the buffer is returned.

pub fn scan_bytes_aligned_ref( &mut self, pattern: &[u8], align: usize, scan_len: usize, ) -> Result<&'a [u8], Error>

Scans up-to scan_len bytes from the stream until a byte pattern is matched on the specified byte alignment boundary. Operation is otherwise identical to scan_bytes_ref.

pub fn read_buf_bytes_ref(&mut self, len: usize) -> Result<&'a [u8], Error>

Returns a reference to the next len bytes in the buffer and advances the stream.

pub fn read_buf_bytes_available_ref(&mut self) -> &'a [u8]

Returns a reference to the remaining bytes in the buffer and advances the stream to the end.

Trait Implementations

impl<'a> FiniteStream for BufReader<'a>

fn byte_len(&self) -> u64

Returns the length of the the stream in bytes.

fn bytes_read(&self) -> u64

Returns the number of bytes that have been read.

fn bytes_available(&self) -> u64

Returns the number of bytes available for reading.

impl<'a> ReadBytes for BufReader<'a>

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

Reads a single byte from the stream and returns it or an error.

fn read_double_bytes(&mut self) -> Result<[u8; 2], Error>

Reads two bytes from the stream and returns them in read-order or an error.

fn read_triple_bytes(&mut self) -> Result<[u8; 3], Error>

Reads three bytes from the stream and returns them in read-order or an error.

fn read_quad_bytes(&mut self) -> Result<[u8; 4], Error>

Reads four bytes from the stream and returns them in read-order or an error.

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

Reads up-to the number of bytes required to fill buf or returns an error.

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

Reads exactly the number of bytes required to fill be provided buffer or returns an error.

fn scan_bytes_aligned<'b>( &mut self, pattern: &[u8], align: usize, buf: &'b mut [u8], ) -> Result<&'b mut [u8], Error>

Reads bytes from a stream into a supplied buffer until a byte patter is matched on an aligned byte boundary. Returns a mutable slice to the valid region of the provided buffer.

fn ignore_bytes(&mut self, count: u64) -> Result<(), Error>

Ignores the specified number of bytes from the stream or returns an error.

fn pos(&self) -> u64

Gets the position of the stream.

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

Reads a single unsigned byte from the stream and returns it or an error.

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

Reads a single signed byte from the stream and returns it or an error.

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

Reads two bytes from the stream and interprets them as an unsigned 16-bit little-endian integer or returns an error.

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

Reads two bytes from the stream and interprets them as an signed 16-bit little-endian integer or returns an error.

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

Reads two bytes from the stream and interprets them as an unsigned 16-bit big-endian integer or returns an error.

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

Reads two bytes from the stream and interprets them as an signed 16-bit big-endian integer or returns an error.

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

Reads three bytes from the stream and interprets them as an unsigned 24-bit little-endian integer or returns an error.

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

Reads three bytes from the stream and interprets them as an signed 24-bit little-endian integer or returns an error.

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

Reads three bytes from the stream and interprets them as an unsigned 24-bit big-endian integer or returns an error.

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

Reads three bytes from the stream and interprets them as an signed 24-bit big-endian integer or returns an error.

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

Reads four bytes from the stream and interprets them as an unsigned 32-bit little-endian integer or returns an error.

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

Reads four bytes from the stream and interprets them as an signed 32-bit little-endian integer or returns an error.

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

Reads four bytes from the stream and interprets them as an unsigned 32-bit big-endian integer or returns an error.

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

Reads four bytes from the stream and interprets them as a signed 32-bit big-endian integer or returns an error.

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

Reads eight bytes from the stream and interprets them as an unsigned 64-bit little-endian integer or returns an error.

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

Reads eight bytes from the stream and interprets them as an signed 64-bit little-endian integer or returns an error.

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

Reads eight bytes from the stream and interprets them as an unsigned 64-bit big-endian integer or returns an error.

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

Reads eight bytes from the stream and interprets them as an signed 64-bit big-endian integer or returns an error.

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

Reads four bytes from the stream and interprets them as a 32-bit little-endian IEEE-754 floating-point value.

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

Reads four bytes from the stream and interprets them as a 32-bit big-endian IEEE-754 floating-point value.

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

Reads four bytes from the stream and interprets them as a 64-bit little-endian IEEE-754 floating-point value.

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

Reads four bytes from the stream and interprets them as a 64-bit big-endian IEEE-754 floating-point value.

fn read_boxed_slice(&mut self, len: usize) -> Result<Box<[u8]>, Error>

Reads up-to the number of bytes requested, and returns a boxed slice of the data or an error.

fn read_boxed_slice_exact(&mut self, len: usize) -> Result<Box<[u8]>, Error>

Reads exactly the number of bytes requested, and returns a boxed slice of the data or an error.

fn scan_bytes<'a>( &mut self, pattern: &[u8], buf: &'a mut [u8], ) -> Result<&'a mut [u8], Error>

Reads bytes from the stream into a supplied buffer until a byte pattern is matched. Returns a mutable slice to the valid region of the provided buffer.