Struct U32BEPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> U32BEPacket<'a>

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

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

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

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

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

Maps from a U32BEPacket to a U32BEPacket

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

Maps from a U32BEPacket 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 get_number(&self) -> u32be

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

Trait Implementations

impl<'p> Debug for U32BEPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for U32BEPacket<'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> Packet for U32BEPacket<'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 U32BEPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for U32BEPacket<'p>

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