Struct binreader::RandomAccessBinReader

pub struct RandomAccessBinReader { /* fields omitted */ }

Trait Implementations

impl AsRef<[u8]> for RandomAccessBinReader

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl<'r> BinReader<'r> for RandomAccessBinReader

fn from_slice_with_offset(
    slice: &[u8],
    initial_offset: usize,
    endidness: Endidness
) -> Result<Self>

Generates a new BinReader using the provided slice, initial offset, and endidness. While the exact implementation of this varies from implementation to implementation, OwnableBinReaders will, more than likely, copy the data in the slice.

fn initial_offset(&self) -> usize

The initial offset of the BinReader. For more information, see the Offsets section of the BinReader documentation.

fn is_empty(&self) -> bool

Checks whether or not there is any data left, based off of the BinReader::current_offset.

fn size(&self) -> usize

The amount of data in the reader. If the reader’s size changes (which none of the implementations currently do), then this should return how much data was initially in the reader.

fn remaining(&self) -> usize

The amount of data left, based off of the BinReader::current_offset.

fn current_offset(&self) -> usize

The current offset of the reader’s cursor.

fn endidness(&self) -> Endidness

The endidness of the reader.

fn change_endidness(&mut self, endidness: Endidness)

Changes the default endidness.

fn advance_to(&self, offset: usize) -> Result<()>

Sets the reader’s BinReader::current_offset.

fn advance_by(&self, bytes: isize) -> Result<()>

Alters the BinReader::current_offset by the given amount.

fn next_u8(&self) -> Result<u8>

Gets the current byte and then advances the cursor.

fn next_n_bytes(&self, num_bytes: usize) -> Result<Bytes>

Returns a Bytes object of the requested size containing the next n bytes (where n is the num_bytes parameter) and then advances the cursor by that much.

fn from_slice(slice: &'r [u8], endidness: Endidness) -> Result<Self>

Functions the same as the BinReader::from_slice_with_offset, except the initial offset is always 0.

fn lower_offset_limit(&self) -> usize

The lowest valid offset that can be requested. By default, this is the same as BinReader::initial_offset.

fn upper_offset_limit(&self) -> usize

The highest valid offset that can be requested. By default, this is the reader’s BinReader::size plus its BinReader::initial_offset.

fn validate_offset(&self, offset: usize, size: usize) -> Result<()>

A helper method that validates an offset (mostly used by reader implementations).

fn relative_offset(&self, abs_offset: usize) -> Result<usize>

Takes an absolute offset and converts it to a relative offset, based off of the BinReader::current_offset.

fn next_bytes_are(&self, prefix: &[u8]) -> Result<bool>

Returns true if the next bytes are the same as the ones provided.

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

Fills the provided buffer with bytes, starting at the provided offset. This does not alter the BinReader::current_offset.

fn subseq(&self, offset: usize, num_bytes: usize) -> Result<&[u8]>

Returns a subsequence (i.e. a &[u8]) of data of the requested size beginning at the provided offset.

fn range(&self, start: usize, end: usize) -> Result<&[u8]>

Returns a slice of the data between the provided starting and ending offsets.

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

Fills the provided buffer with the next n bytes, where n is the length of the buffer. This then advances the BinReader::current_offset by n.

fn current_u8(&self) -> Result<u8>

Gets the u8 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i8_ne(&self) -> Result<i8>

Gets the nelong endian i8 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u16_be(&self) -> Result<u16>

Gets the belong endian u16 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u16_le(&self) -> Result<u16>

Gets the lelong endian u16 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i16_be(&self) -> Result<i16>

Gets the belong endian i16 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i16_le(&self) -> Result<i16>

Gets the lelong endian i16 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u32_be(&self) -> Result<u32>

Gets the belong endian u32 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u32_le(&self) -> Result<u32>

Gets the lelong endian u32 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i32_be(&self) -> Result<i32>

Gets the belong endian i32 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i32_le(&self) -> Result<i32>

Gets the lelong endian i32 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u64_be(&self) -> Result<u64>

Gets the belong endian u64 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u64_le(&self) -> Result<u64>

Gets the lelong endian u64 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i64_be(&self) -> Result<i64>

Gets the belong endian i64 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i64_le(&self) -> Result<i64>

Gets the lelong endian i64 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u128_be(&self) -> Result<u128>

Gets the belong endian u128 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_u128_le(&self) -> Result<u128>

Gets the lelong endian u128 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i128_be(&self) -> Result<i128>

Gets the belong endian i128 at the BinReader::current_offset without altering the BinReader::current_offset.

fn current_i128_le(&self) -> Result<i128>

Gets the lelong endian i128 at the BinReader::current_offset without altering the BinReader::current_offset.

fn u8_at(&self, offset: usize) -> Result<u8>

Gets the u8 at the provided offset without altering the BinReader::current_offset.

fn i8_ne_at(&self, offset: usize) -> Result<i8>

Gets the nelong endian i8 at the provided offset without altering the BinReader::current_offset.

fn u16_be_at(&self, offset: usize) -> Result<u16>

Gets the belong endian u16 at the provided offset without altering the BinReader::current_offset.

fn u16_le_at(&self, offset: usize) -> Result<u16>

Gets the lelong endian u16 at the provided offset without altering the BinReader::current_offset.

fn i16_be_at(&self, offset: usize) -> Result<i16>

Gets the belong endian i16 at the provided offset without altering the BinReader::current_offset.

fn i16_le_at(&self, offset: usize) -> Result<i16>

Gets the lelong endian i16 at the provided offset without altering the BinReader::current_offset.

fn u32_be_at(&self, offset: usize) -> Result<u32>

Gets the belong endian u32 at the provided offset without altering the BinReader::current_offset.

fn u32_le_at(&self, offset: usize) -> Result<u32>

Gets the lelong endian u32 at the provided offset without altering the BinReader::current_offset.

fn i32_be_at(&self, offset: usize) -> Result<i32>

Gets the belong endian i32 at the provided offset without altering the BinReader::current_offset.

fn i32_le_at(&self, offset: usize) -> Result<i32>

Gets the lelong endian i32 at the provided offset without altering the BinReader::current_offset.

fn u64_be_at(&self, offset: usize) -> Result<u64>

Gets the belong endian u64 at the provided offset without altering the BinReader::current_offset.

fn u64_le_at(&self, offset: usize) -> Result<u64>

Gets the lelong endian u64 at the provided offset without altering the BinReader::current_offset.

fn i64_be_at(&self, offset: usize) -> Result<i64>

Gets the belong endian i64 at the provided offset without altering the BinReader::current_offset.

fn i64_le_at(&self, offset: usize) -> Result<i64>

Gets the lelong endian i64 at the provided offset without altering the BinReader::current_offset.

fn u128_be_at(&self, offset: usize) -> Result<u128>

Gets the belong endian u128 at the provided offset without altering the BinReader::current_offset.

fn u128_le_at(&self, offset: usize) -> Result<u128>

Gets the lelong endian u128 at the provided offset without altering the BinReader::current_offset.

fn i128_be_at(&self, offset: usize) -> Result<i128>

Gets the belong endian i128 at the provided offset without altering the BinReader::current_offset.

fn i128_le_at(&self, offset: usize) -> Result<i128>

Gets the lelong endian i128 at the provided offset without altering the BinReader::current_offset.

fn u16_at(&self, offset: usize) -> Result<u16>

Gets the u16 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn u32_at(&self, offset: usize) -> Result<u32>

Gets the u32 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn u64_at(&self, offset: usize) -> Result<u64>

Gets the u64 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn u128_at(&self, offset: usize) -> Result<u128>

Gets the u128 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn i16_at(&self, offset: usize) -> Result<i16>

Gets the i16 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn i32_at(&self, offset: usize) -> Result<i32>

Gets the i32 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn i64_at(&self, offset: usize) -> Result<i64>

Gets the i64 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn i128_at(&self, offset: usize) -> Result<i128>

Gets the i128 using the default endidness at the provided offset without altering the BinReader::current_offset. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i8_ne(&self) -> Result<i8>

Gets the nelong endian i8 at the BinReader::current_offset and then advances it by 1.

fn next_u16_be(&self) -> Result<u16>

Gets the belong endian u16 at the BinReader::current_offset and then advances it by 1.

fn next_u16_le(&self) -> Result<u16>

Gets the lelong endian u16 at the BinReader::current_offset and then advances it by 1.

fn next_i16_be(&self) -> Result<i16>

Gets the belong endian i16 at the BinReader::current_offset and then advances it by 1.

fn next_i16_le(&self) -> Result<i16>

Gets the lelong endian i16 at the BinReader::current_offset and then advances it by 1.

fn next_u32_be(&self) -> Result<u32>

Gets the belong endian u32 at the BinReader::current_offset and then advances it by 1.

fn next_u32_le(&self) -> Result<u32>

Gets the lelong endian u32 at the BinReader::current_offset and then advances it by 1.

fn next_i32_be(&self) -> Result<i32>

Gets the belong endian i32 at the BinReader::current_offset and then advances it by 1.

fn next_i32_le(&self) -> Result<i32>

Gets the lelong endian i32 at the BinReader::current_offset and then advances it by 1.

fn next_u64_be(&self) -> Result<u64>

Gets the belong endian u64 at the BinReader::current_offset and then advances it by 1.

fn next_u64_le(&self) -> Result<u64>

Gets the lelong endian u64 at the BinReader::current_offset and then advances it by 1.

fn next_i64_be(&self) -> Result<i64>

Gets the belong endian i64 at the BinReader::current_offset and then advances it by 1.

fn next_i64_le(&self) -> Result<i64>

Gets the lelong endian i64 at the BinReader::current_offset and then advances it by 1.

fn next_u128_be(&self) -> Result<u128>

Gets the belong endian u128 at the BinReader::current_offset and then advances it by 1.

fn next_u128_le(&self) -> Result<u128>

Gets the lelong endian u128 at the BinReader::current_offset and then advances it by 1.

fn next_i128_be(&self) -> Result<i128>

Gets the belong endian i128 at the BinReader::current_offset and then advances it by 1.

fn next_i128_le(&self) -> Result<i128>

Gets the lelong endian i128 at the BinReader::current_offset and then advances it by 1.

fn next_u16(&self) -> Result<u16>

Gets the u16 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_u32(&self) -> Result<u32>

Gets the u16 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_u64(&self) -> Result<u64>

Gets the u16 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_u128(&self) -> Result<u128>

Gets the u16 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i8(&self) -> Result<i8>

Gets the i8 at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i16(&self) -> Result<i16>

Gets the i16 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i32(&self) -> Result<i32>

Gets the i32 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i64(&self) -> Result<i64>

Gets the i64 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

fn next_i128(&self) -> Result<i128>

Gets the i128 using the default endidness at the BinReader::current_offset and then advances it by 1. If the current endidness is Endidness::Unknown, then an error is returned.

impl Borrow<[u8]> for RandomAccessBinReader

fn borrow(&self) -> &[u8]

Immutably borrows from an owned value.

impl BufRead for RandomAccessBinReader

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

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

recently added

Check if the underlying Read has any data left to be read.

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

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

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'r> OwnableBinReader<'r> for RandomAccessBinReader

fn from_file_with_offset<P: AsRef<Path>>(
    path: P,
    initial_offset: usize,
    endidness: Endidness
) -> Result<Self>

fn from_bytes_with_offset(
    bytes: Bytes,
    initial_offset: usize,
    endidness: Endidness
) -> Result<Self>

fn from_file<P: AsRef<Path>>(path: P, endidness: Endidness) -> Result<Self>

fn from_bytes(bytes: Bytes, endidness: Endidness) -> Result<Self>

impl Read for RandomAccessBinReader

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.

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.

impl Seek for RandomAccessBinReader

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

Seek to an offset, in bytes, in a stream.

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

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

Rewind to the beginning of a stream.

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

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

Returns the length of this stream (in bytes).

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

Returns the current seek position from the start of the stream.

impl<'r> SliceableBinReader<'r> for RandomAccessBinReader

fn slice_reader(
    &self,
    start: usize,
    end: usize
) -> Result<SliceRefBinReader<'_>>

fn next_n_bytes_as_reader(
    &self,
    num_bytes: usize
) -> Result<SliceRefBinReader<'_>>

fn next_n_bytes_as_reader_retain_offset(
    &mut self,
    num_bytes: usize
) -> Result<SliceRefBinReader<'_>>

fn slice_reader_with_offset(
    &self,
    start: usize,
    offset: usize,
    end: usize
) -> Result<SliceRefBinReader<'_>>

fn slice_reader_retain_offset(
    &self,
    start: usize,
    end: usize
) -> Result<SliceRefBinReader<'_>>