Struct pnet_packet::udp::MutableUdpPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableUdpPacket<'a>

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

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

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

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

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

Maps from a MutableUdpPacket to a UdpPacket

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

Maps from a MutableUdpPacket 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 populate(&mut self, packet: &Udp)

Populates a UdpPacket using a Udp structure

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.

pub fn set_source(&mut self, val: u16be)

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

pub fn set_destination(&mut self, val: u16be)

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

pub fn set_length(&mut self, val: u16be)

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

pub fn set_checksum(&mut self, val: u16be)

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

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableUdpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableUdpPacket<'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> MutablePacket for MutableUdpPacket<'a>

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

Retreive the underlying, mutable, buffer for the packet.

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

Retreive 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 MutableUdpPacket<'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 MutableUdpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableUdpPacket<'p>> for MutableUdpPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableUdpPacket<'p>