Struct netsim_embed::udp::UdpPacket

pub struct UdpPacket<'p> { /* fields omitted */ }

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> UdpPacket<'a>

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

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

pub fn owned(packet: Vec<u8, Global>) -> Option<UdpPacket<'static>>

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

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

Maps from a UdpPacket to a UdpPacket

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

Maps from a UdpPacket to a UdpPacket 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: &Udp) -> usize

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

pub fn get_source(&self) -> u16

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

pub fn get_destination(&self) -> u16

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

pub fn get_length(&self) -> u16

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

pub fn get_checksum(&self) -> u16

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

Trait Implementations

impl<'p> Debug for UdpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for UdpPacket<'p>

type T = Udp

The type of the packet to convert from.

pub fn from_packet(&self) -> Udp

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

impl<'a> Packet for UdpPacket<'a>

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

Retrieve the underlying buffer for the packet.

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

Retrieve the payload for the packet.

impl<'a> PacketSize for UdpPacket<'a>

pub fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<UdpPacket<'p>> for UdpPacket<'p>

pub fn eq(&self, other: &UdpPacket<'p>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &UdpPacket<'p>) -> bool

This method tests for !=.

impl<'p> StructuralPartialEq for UdpPacket<'p>