Struct pnet::packet::ipv4::Ipv4Packet

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> Ipv4Packet<'a>

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

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

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

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

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

Maps from a Ipv4Packet to a Ipv4Packet

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

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

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

pub fn get_version(&self) -> u8

Get the version field.

pub fn get_header_length(&self) -> u8

Get the header_length field.

pub fn get_dscp(&self) -> u8

Get the dscp field.

pub fn get_ecn(&self) -> u8

Get the ecn field.

pub fn get_total_length(&self) -> u16

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

pub fn get_identification(&self) -> u16

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

pub fn get_flags(&self) -> u8

Get the flags field.

pub fn get_fragment_offset(&self) -> u16

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

pub fn get_ttl(&self) -> u8

Get the ttl field.

pub fn get_next_level_protocol(&self) -> IpNextHeaderProtocol

Get the value of the next_level_protocol field

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.

pub fn get_source(&self) -> Ipv4Addr

Get the value of the source field

pub fn get_destination(&self) -> Ipv4Addr

Get the value of the destination field

pub fn get_options_raw(&self) -> &[u8]

Get the raw &u8 value of the options field, without copying

pub fn get_options(&self) -> Vec<Ipv4Option>

Get the value of the options field (copies contents)

pub fn get_options_iter(&self) -> Ipv4OptionIterable<'_>

Get the value of the options field as iterator

Trait Implementations

impl<'p> Debug for Ipv4Packet<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for Ipv4Packet<'p>

type T = Ipv4

The type of the packet to convert from.

fn from_packet(&self) -> Ipv4

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

impl<'a> Packet for Ipv4Packet<'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 Ipv4Packet<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq for Ipv4Packet<'p>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'p> StructuralPartialEq for Ipv4Packet<'p>