Struct Packet

pub struct Packet<'a> {
    pub header: &'a Header,
    pub payload: &'a [u8],
}

A typed reference to the contents of a packet in a buffer.

Fields

header: &'a Header

The packet’s header

payload: &'a [u8]

The packet’s payload

Implementations

impl<'a> Packet<'a>

pub fn size(&self) -> usize

The size of this packet according to its header (as Self::payload may have been over-allocated for the size of the packet).

pub fn write_to_unchecked(&'a self, buf: &'a mut [u8]) -> &'a mut [u8]

Writes the packet to a buffer when the buffer is known to be large enough to hold it. Note that the packet header’s Header::payload_len must be correct before calling this, it does not use the size of Self::payload to decide how much of the payload buffer is valid.

Panics

Panics if the buffer is not large enough for the packet.

Trait Implementations

impl<'a> Debug for Packet<'a>

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

Formats the value using the given formatter.

impl<'a> Ord for Packet<'a>

fn cmp(&self, other: &Packet<'a>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for Packet<'a>

fn eq(&self, other: &Packet<'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> PartialOrd for Packet<'a>

fn partial_cmp(&self, other: &Packet<'a>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> Eq for Packet<'a>

impl<'a> StructuralPartialEq for Packet<'a>