Struct pnet_packet::icmp::MutableIcmpPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> MutableIcmpPacket<'a>

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

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

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

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

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

Maps from a MutableIcmpPacket to a IcmpPacket

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

Maps from a MutableIcmpPacket to a IcmpPacket 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: &Icmp) -> usize

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

pub fn populate(&mut self, packet: &Icmp)

Populates a IcmpPacket using a Icmp structure

pub fn get_icmp_type(&self) -> IcmpType

Get the value of the icmp_type field

pub fn get_icmp_code(&self) -> IcmpCode

Get the value of the icmp_code 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 set_icmp_type(&mut self, val: IcmpType)

Set the value of the icmp_type field.

pub fn set_icmp_code(&mut self, val: IcmpCode)

Set the value of the icmp_code 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_payload(&mut self, vals: &[u8])

Set the value of the payload field (copies contents)

Trait Implementations

impl<'p> Debug for MutableIcmpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for MutableIcmpPacket<'p>

type T = Icmp

The type of the packet to convert from.

fn from_packet(&self) -> Icmp

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

impl<'a> MutablePacket for MutableIcmpPacket<'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 MutableIcmpPacket<'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 MutableIcmpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<MutableIcmpPacket<'p>> for MutableIcmpPacket<'p>

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

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

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

This method tests for !=.

impl<'p> StructuralPartialEq for MutableIcmpPacket<'p>