Trait symphonia_core::io::ReadBytes

pub trait ReadBytes {
    // Required methods
    fn read_byte(&mut self) -> Result<u8>;
    fn read_double_bytes(&mut self) -> Result<[u8; 2]>;
    fn read_triple_bytes(&mut self) -> Result<[u8; 3]>;
    fn read_quad_bytes(&mut self) -> Result<[u8; 4]>;
    fn read_buf(&mut self, buf: &mut [u8]) -> Result<usize>;
    fn read_buf_exact(&mut self, buf: &mut [u8]) -> Result<()>;
    fn scan_bytes_aligned<'a>(
        &mut self,
        pattern: &[u8],
        align: usize,
        buf: &'a mut [u8],
    ) -> Result<&'a mut [u8]>;
    fn ignore_bytes(&mut self, count: u64) -> Result<()>;
    fn pos(&self) -> u64;

    // Provided methods
    fn read_u8(&mut self) -> Result<u8> { ... }
    fn read_i8(&mut self) -> Result<i8> { ... }
    fn read_u16(&mut self) -> Result<u16> { ... }
    fn read_i16(&mut self) -> Result<i16> { ... }
    fn read_be_u16(&mut self) -> Result<u16> { ... }
    fn read_be_i16(&mut self) -> Result<i16> { ... }
    fn read_u24(&mut self) -> Result<u32> { ... }
    fn read_i24(&mut self) -> Result<i32> { ... }
    fn read_be_u24(&mut self) -> Result<u32> { ... }
    fn read_be_i24(&mut self) -> Result<i32> { ... }
    fn read_u32(&mut self) -> Result<u32> { ... }
    fn read_i32(&mut self) -> Result<i32> { ... }
    fn read_be_u32(&mut self) -> Result<u32> { ... }
    fn read_be_i32(&mut self) -> Result<i32> { ... }
    fn read_u64(&mut self) -> Result<u64> { ... }
    fn read_i64(&mut self) -> Result<i64> { ... }
    fn read_be_u64(&mut self) -> Result<u64> { ... }
    fn read_be_i64(&mut self) -> Result<i64> { ... }
    fn read_f32(&mut self) -> Result<f32> { ... }
    fn read_be_f32(&mut self) -> Result<f32> { ... }
    fn read_f64(&mut self) -> Result<f64> { ... }
    fn read_be_f64(&mut self) -> Result<f64> { ... }
    fn read_boxed_slice(&mut self, len: usize) -> Result<Box<[u8]>> { ... }
    fn read_boxed_slice_exact(&mut self, len: usize) -> Result<Box<[u8]>> { ... }
    fn scan_bytes<'a>(
        &mut self,
        pattern: &[u8],
        buf: &'a mut [u8],
    ) -> Result<&'a mut [u8]> { ... }
}

ReadBytes provides methods to read bytes and interpret them as little- or big-endian unsigned integers or floating-point values of standard widths.

Required Methods

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

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

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

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

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

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

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

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>

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<()>

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

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

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<()>

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

fn pos(&self) -> u64

Gets the position of the stream.

Provided Methods

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

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

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

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

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

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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]>>

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]>>

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]>

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.

Implementations on Foreign Types

impl<'b, R: ReadBytes> ReadBytes for &'b mut R

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

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

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

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

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

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

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

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

fn pos(&self) -> u64

Implementors

impl ReadBytes for MediaSourceStream

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

impl<B: ReadBytes> ReadBytes for ScopedStream<B>

impl<B: ReadBytes, M: Monitor> ReadBytes for MonitorStream<B, M>