Struct pnet_packet::udp::UdpPacket
[−]
[src]
pub struct UdpPacket<'p> { /* fields omitted */ }
A structure enabling manipulation of on the wire packets
Methods
impl<'a> UdpPacket<'a>
[src]
pub fn new<'p>(packet: &'p [u8]) -> Option<UdpPacket<'p>>
[src]
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>>
[src]
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>
[src]
Maps from a UdpPacket to a UdpPacket
pub fn consume_to_immutable(self) -> UdpPacket<'a>
[src]
Maps from a UdpPacket to a UdpPacket while consuming the source
pub fn minimum_packet_size() -> usize
[src]
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
[src]
The size (in bytes) of a Udp instance when converted into a byte-array
pub fn get_source(&self) -> u16be
[src]
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
[src]
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
[src]
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
[src]
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 for UdpPacket<'p>
[src]
fn eq(&self, __arg_0: &UdpPacket<'p>) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &UdpPacket<'p>) -> bool
[src]
This method tests for !=
.
impl<'a> PacketSize for UdpPacket<'a>
[src]
fn packet_size(&self) -> usize
[src]
Get the calculated size of the packet
impl<'a> Packet for UdpPacket<'a>
[src]
fn packet<'p>(&'p self) -> &'p [u8]
[src]
Retreive the underlying buffer for the packet
fn payload<'p>(&'p self) -> &'p [u8]
[src]
Retreive the payload for the packet
impl<'p> FromPacket for UdpPacket<'p>
[src]
type T = Udp
The type of the packet to convert from
fn from_packet(&self) -> Udp
[src]
Converts a wire-format packet to #[packet] struct format