Struct MutableU16BEPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableU16BEPacket<'a>

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

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

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

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

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

Maps from a MutableU16BEPacket to a U16BEPacket

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

Maps from a MutableU16BEPacket to a U16BEPacket 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: &U16BE) -> usize

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

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

Populates a U16BEPacket using a U16BE structure

pub fn get_number(&self) -> u16

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: u16)

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 MutableU16BEPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableU16BEPacket<'p>

type T = U16BE

The type of the packet to convert from.

fn from_packet(&self) -> U16BE

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

impl<'a> MutablePacket for MutableU16BEPacket<'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 MutableU16BEPacket<'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 MutableU16BEPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for MutableU16BEPacket<'p>

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