Struct pnet_packet::udp::UdpPacket

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

A structure enabling manipulation of on the wire packets

Methods

impl<'a> UdpPacket<'a>

pub fn new<'p>(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>) -> 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>(&'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 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) -> u16be

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) -> u16be

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) -> u16be

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) -> u16be

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

Trait Implementations

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

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

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

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

This method tests for !=.

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

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

Formats the value using the given formatter.

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

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

Retreive the underlying buffer for the packet

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

Retreive the payload for the packet

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

type T = Udp

The type of the packet to convert from

fn from_packet(&self) -> Udp

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

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

fn packet_size(&self) -> usize

Get the calculated size of the packet