Struct PacketMut

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

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

Fields

header: &'a mut Header

The packet’s header.

payload: &'a mut [u8]

The packet’s payload.

Implementations

impl<'a> PacketMut<'a>

pub fn new_in(packet_type: PacketType, buf: &'a mut [u8]) -> Self

Creates a new PacketMut inside the given buffer and initializes the header to the given PacketType before returning it. All other fields in the header will be zeroed, and the PacketMut::payload will be the remaining area of the buffer after the header.

Use PacketMut::finish to validate and write the proper packet length and return the total size of the packet.

Panics

The buffer must be large enough to hold at least a packet header, and this will panic if it’s not.

pub fn finish(self, payload_len: usize) -> Result<usize, PacketTooBigError>

Validates the correctness of the packet and returns the size of the packet within the original buffer.

Trait Implementations

impl<'a> Debug for PacketMut<'a>

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

Formats the value using the given formatter.

impl<'a> Ord for PacketMut<'a>

fn cmp(&self, other: &PacketMut<'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 PacketMut<'a>

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

fn partial_cmp(&self, other: &PacketMut<'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 PacketMut<'a>

impl<'a> StructuralPartialEq for PacketMut<'a>