Struct ByteReader

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

Reads bytes from an underlying byte-slice.

Implementations

impl<'a> ByteReader<'a>

pub fn new(data: &'a [u8]) -> ByteReader<'a>

Creates a new reader for a slice of bytes.

pub fn sub_reader( &mut self, length: usize, ) -> Result<ByteReader<'a>, ParseError>

Creates a second reader for a sub-slice of this reader. The slice of the second reader starts at the current offset and ends at offset + length. Also advances this readers offset by length.

A lot of variable length SOME/IP types are prefixed with their length in bytes, so this allows creating a sub-reader and reading bytes until it is empty.

pub fn take_remaining(&mut self) -> ByteReader<'a>

Returns a new sub-reader with the remaining slice and advances the reader.

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

Reads a single byte and advances the reader.

pub fn read_slice(&mut self, length: usize) -> Result<&'a [u8], ParseError>

Returns a slice of bytes with the given length and advances the reader.

pub fn read_array<const N: usize>(&mut self) -> Result<[u8; N], ParseError>

Reads an array of N bytes and advances the reader.

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

Returns the remaining slice without advancing the offset.

pub fn consume_matching_bytes(&mut self, compare_to: &[u8]) -> bool

Consumes bytes matching the provided input. Returns whether or not there was a match.

Returns false if are there not enough bytes to compare to.

pub fn len(&self) -> usize

Returns the length of the remaining slice.

pub fn is_empty(&self) -> bool

Returns true if there are no bytes left to read.

Trait Implementations

impl<'a> Clone for ByteReader<'a>

fn clone(&self) -> ByteReader<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ByteReader<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'a> PartialEq for ByteReader<'a>

fn eq(&self, other: &ByteReader<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Eq for ByteReader<'a>

impl<'a> StructuralPartialEq for ByteReader<'a>