Struct pnet_packet::ipv4::MutableIpv4Packet

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableIpv4Packet<'a>

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

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

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

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

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

Maps from a MutableIpv4Packet to a Ipv4Packet

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

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

Populates a Ipv4Packet using a Ipv4 structure

pub fn get_version(&self) -> u4

Get the version field.

pub fn get_header_length(&self) -> u4

Get the header_length field.

pub fn get_dscp(&self) -> u6

Get the dscp field.

pub fn get_ecn(&self) -> u2

Get the ecn field.

pub fn get_total_length(&self) -> u16be

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

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

Get the flags field.

pub fn get_fragment_offset(&self) -> u13be

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

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

pub fn set_version(&mut self, val: u4)

Set the version field.

pub fn set_header_length(&mut self, val: u4)

Set the header_length field.

pub fn set_dscp(&mut self, val: u6)

Set the dscp field.

pub fn set_ecn(&mut self, val: u2)

Set the ecn field.

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

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

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

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

pub fn set_flags(&mut self, val: u3)

Set the flags field.

pub fn set_fragment_offset(&mut self, val: u13be)

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

pub fn set_ttl(&mut self, val: u8)

Set the ttl field.

pub fn set_next_level_protocol(&mut self, val: IpNextHeaderProtocol)

Set the value of the next_level_protocol field.

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_source(&mut self, val: Ipv4Addr)

Set the value of the source field.

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

Set the value of the destination field.

pub fn get_options_raw_mut(&mut self) -> &mut [u8]

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

pub fn set_options(&mut self, vals: &[Ipv4Option])

Set the value of the options field (copies contents)

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

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableIpv4Packet<'p>

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

Formats the value using the given formatter.

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

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableIpv4Packet<'p>> for MutableIpv4Packet<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableIpv4Packet<'p>