Struct pnet::packet::icmp::IcmpPacket

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

A structure enabling manipulation of on the wire packets

Implementations

impl<'a> IcmpPacket<'a>

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

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

pub fn owned(packet: Vec<u8, Global>) -> Option<IcmpPacket<'static>>

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

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

Maps from a IcmpPacket to a IcmpPacket

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

Maps from a IcmpPacket 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 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) -> u16

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

Trait Implementations

impl<'p> Debug for IcmpPacket<'p>

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

Formats the value using the given formatter.

impl<'p> FromPacket for IcmpPacket<'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> Packet for IcmpPacket<'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 IcmpPacket<'a>

fn packet_size(&self) -> usize

Get the calculated size of the packet.

impl<'p> PartialEq<IcmpPacket<'p>> for IcmpPacket<'p>

fn eq(&self, other: &IcmpPacket<'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 IcmpPacket<'p>