Struct packtool::View

pub struct View<'a, T: ?Sized> { /* fields omitted */ }

view of a slice in memory as a packed structure of type T

Implementations

impl<'a, T> View<'a, T> where
    T: Packed, 

#[must_use = "this will clone data from the slice, it is often expensive"]

pub fn unpack(self) -> T

reconstruct the object T from the given View

this function will involve some hoops and loops and may involve some heap allocation.

#[must_use = "this will copy the memory slice"]

pub fn to_owned(self) -> Packet<T>

create a clone of the given slice that is going to be owned by the given Packet.

Only do that if you need to hold onto the serialized data.

pub fn try_from_slice(slice: &'a [u8]) -> Result<Self, Error>

create a View from the given slice.

this function will perform all the necessary checks in order to make sure there’s no invalid data.

Once the View is created, it is possible to use it safely across the board.

Trait Implementations

impl<'a, T> AsRef<[u8]> for View<'a, T>

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

Performs the conversion.

impl<'a, T> Clone for View<'a, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T> Debug for View<'a, T>

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

Formats the value using the given formatter.

impl<'a, T> Hash for View<'a, T>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, T> Ord for View<'a, T>

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<'a, 'b, T, U> PartialEq<View<'b, U>> for View<'a, T>

fn eq(&self, other: &View<'b, U>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b, T, U> PartialOrd<View<'b, U>> for View<'a, T>

fn partial_cmp(&self, other: &View<'b, U>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T> Copy for View<'a, T>

impl<'a, T> Eq for View<'a, T>