Struct object::read::Bytes

pub struct Bytes<'data>(pub &'data [u8]);

A newtype for byte slices.

It has these important features:

• no methods that can panic, such as Index
• convenience methods for Pod types
• a useful Debug implementation

Tuple Fields

0: &'data [u8]

Implementations

impl<'data> Bytes<'data>

pub fn len(&self) -> usize

Return the length of the byte slice.

pub fn is_empty(&self) -> bool

Return true if the byte slice is empty.

pub fn skip(&mut self, offset: usize) -> Result<(), ()>

Skip over the given number of bytes at the start of the byte slice.

Modifies the byte slice to start after the bytes.

Returns an error if there are too few bytes.

pub fn read_bytes(&mut self, count: usize) -> Result<Bytes<'data>, ()>

Return a reference to the given number of bytes at the start of the byte slice.

Modifies the byte slice to start after the bytes.

Returns an error if there are too few bytes.

pub fn read_bytes_at(
    self,
    offset: usize,
    count: usize
) -> Result<Bytes<'data>, ()>

Return a reference to the given number of bytes at the given offset of the byte slice.

Returns an error if the offset is invalid or there are too few bytes.

pub fn read<T: Pod>(&mut self) -> Result<&'data T, ()>

Return a reference to a Pod struct at the start of the byte slice.

Modifies the byte slice to start after the bytes.

Returns an error if there are too few bytes or the slice is incorrectly aligned.

pub fn read_at<T: Pod>(self, offset: usize) -> Result<&'data T, ()>

Return a reference to a Pod struct at the given offset of the byte slice.

Returns an error if there are too few bytes or the offset is incorrectly aligned.

pub fn read_slice<T: Pod>(&mut self, count: usize) -> Result<&'data [T], ()>

Return a reference to a slice of Pod structs at the start of the byte slice.

Modifies the byte slice to start after the bytes.

Returns an error if there are too few bytes or the offset is incorrectly aligned.

pub fn read_slice_at<T: Pod>(
    self,
    offset: usize,
    count: usize
) -> Result<&'data [T], ()>

Return a reference to a slice of Pod structs at the given offset of the byte slice.

Returns an error if there are too few bytes or the offset is incorrectly aligned.

pub fn read_string(&mut self) -> Result<&'data [u8], ()>

Read a null terminated string.

Does not assume any encoding. Reads past the null byte, but doesn’t return it.

pub fn read_string_at(self, offset: usize) -> Result<&'data [u8], ()>

Read a null terminated string at an offset.

Does not assume any encoding. Does not return the null byte.

Trait Implementations

impl<'data> Clone for Bytes<'data>

fn clone(&self) -> Bytes<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for Bytes<'data>

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

Formats the value using the given formatter.

impl<'data> Default for Bytes<'data>

fn default() -> Bytes<'data>

Returns the “default value” for a type.

impl<'data> PartialEq<Bytes<'data>> for Bytes<'data>

fn eq(&self, other: &Bytes<'data>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'data> Copy for Bytes<'data>

impl<'data> Eq for Bytes<'data>

impl<'data> StructuralEq for Bytes<'data>

impl<'data> StructuralPartialEq for Bytes<'data>