Struct object::read::Bytes

source · [−]

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

Expand description

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

source

impl<'data> Bytes<'data>

source

pub fn len(&self) -> usize

Return the length of the byte slice.

source

pub fn is_empty(&self) -> bool

Return true if the byte slice is empty.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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.

source

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> Bytes<'data>

Returns the “default value” for a type. Read more

source

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

source

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

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

source

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

This method tests for !=.

source

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

Auto Trait Implementations

impl<'data> RefUnwindSafe for Bytes<'data>

impl<'data> Send for Bytes<'data>

impl<'data> Sync for Bytes<'data>

impl<'data> Unpin for Bytes<'data>

impl<'data> UnwindSafe for Bytes<'data>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct object::read::Bytes

Tuple Fields

Implementations

impl<'data> Bytes<'data>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

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

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

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

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

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

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

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

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

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

Trait Implementations

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

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

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

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

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

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

fn default() -> Bytes<'data>

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

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

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

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

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

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

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

Auto Trait Implementations

impl<'data> RefUnwindSafe for Bytes<'data>

impl<'data> Send for Bytes<'data>

impl<'data> Sync for Bytes<'data>

impl<'data> Unpin for Bytes<'data>

impl<'data> UnwindSafe for Bytes<'data>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,