Struct MutableU32BEPacket

pub struct MutableU32BEPacket<'p> { /* private fields */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableU32BEPacket<'a>

pub fn new<'p>(packet: &'p mut [u8]) -> Option<MutableU32BEPacket<'p>>

Constructs a new MutableU32BEPacket. If the provided buffer is less than the minimum required packet size, this will return None.

pub fn owned(packet: Vec<u8>) -> Option<MutableU32BEPacket<'static>>

Constructs a new MutableU32BEPacket. If the provided buffer is less than the minimum required packet size, this will return None. With this constructor the MutableU32BEPacket will own its own data and the underlying buffer will be dropped when the MutableU32BEPacket is.

pub fn to_immutable<'p>(&'p self) -> U32BEPacket<'p>

Maps from a MutableU32BEPacket to a U32BEPacket

pub fn consume_to_immutable(self) -> U32BEPacket<'a>

Maps from a MutableU32BEPacket to a U32BEPacket while consuming the source

pub const fn minimum_packet_size() -> usize

The minimum size (in bytes) a packet of this type can be. It’s based on the total size of the fixed-size fields.

pub fn packet_size(_packet: &U32BE) -> usize

The size (in bytes) of a U32BE instance when converted into a byte-array

pub fn populate(&mut self, packet: &U32BE)

Populates a U32BEPacket using a U32BE structure

pub fn get_number(&self) -> u32be

Get the number field. This field is always stored big-endian within the struct, but this accessor returns host order.

pub fn set_number(&mut self, val: u32be)

Set the number field. This field is always stored big-endian within the struct, but this mutator wants host order.

pub fn set_unused(&mut self, vals: &[u8])

Set the value of the unused field (copies contents)

Trait Implementations

impl<'p> Debug for MutableU32BEPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableU32BEPacket<'p>

type T = U32BE

The type of the packet to convert from.

fn from_packet(&self) -> U32BE

Converts a wire-format packet to #[packet] struct format.

impl<'a> MutablePacket for MutableU32BEPacket<'a>

fn packet_mut<'p>(&'p mut self) -> &'p mut [u8]

Retrieve the underlying, mutable, buffer for the packet.

fn payload_mut<'p>(&'p mut self) -> &'p mut [u8]

Retrieve the mutable payload for the packet.

fn clone_from<T>(&mut self, other: &T)

where T: Packet,

Initialize this packet by cloning another.

impl<'a> Packet for MutableU32BEPacket<'a>

fn packet<'p>(&'p self) -> &'p [u8]

Retrieve the underlying buffer for the packet.

fn payload<'p>(&'p self) -> &'p [u8]

Retrieve the payload for the packet.

impl<'a> PacketSize for MutableU32BEPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableU32BEPacket<'p>

fn eq(&self, other: &MutableU32BEPacket<'p>) -> 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<'p> StructuralPartialEq for MutableU32BEPacket<'p>