Struct ScopedStream

pub struct ScopedStream<B>
where
    B: ReadBytes,
{ /* private fields */ }

Available on crate feature dep_symphonia only.

A ScopedStream restricts the number of bytes that may be read to an upper limit.

Implementations

impl<B> ScopedStream<B>

where B: ReadBytes,

pub fn new(inner: B, len: u64) -> ScopedStream<B>

Instantiates a new ScopedStream with an upper limit on the number of bytes that can be read from the inner source.

pub fn inner(&self) -> &B

Returns an immutable reference to the inner stream.

pub fn inner_mut(&mut self) -> &mut B

Returns a mutable reference to the inner stream.

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

Ignores the remainder of the ScopedStream.

pub fn into_inner(self) -> B

Convert the ScopedStream to the inner stream.

Trait Implementations

impl<B> FiniteStream for ScopedStream<B>

where B: ReadBytes,

fn byte_len(&self) -> u64

Returns the length of the the ScopedStream.

fn bytes_read(&self) -> u64

Returns the number of bytes read.

fn bytes_available(&self) -> u64

Returns the number of bytes available to read.

impl<B> ReadBytes for ScopedStream<B>

where B: ReadBytes,

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<'a>( &mut self, pattern: &[u8], align: usize, buf: &'a mut [u8], ) -> Result<&'a 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.

impl<B> SeekBuffered for ScopedStream<B>

where B: ReadBytes + SeekBuffered,

fn ensure_seekback_buffer(&mut self, len: usize)

Ensures that len bytes will be available for backwards seeking if len bytes have been previously read.

fn unread_buffer_len(&self) -> usize

Get the number of bytes buffered but not yet read.

fn read_buffer_len(&self) -> usize

Gets the number of bytes buffered and read.

fn seek_buffered(&mut self, pos: u64) -> u64

Seek within the buffered data to an absolute position in the stream. Returns the position seeked to.

fn seek_buffered_rel(&mut self, delta: isize) -> u64

Seek within the buffered data relative to the current position in the stream. Returns the position seeked to.

fn seek_buffered_rev(&mut self, delta: usize)

Seek backwards within the buffered data.