Struct Icmpv4Packet

pub struct Icmpv4Packet<T: AsRef<[u8]>> { /* private fields */ }

A read/write wrapper around an Internet Control Message Protocol version 4 packet buffer.

Implementations

impl<T: AsRef<[u8]>> Packet<T>

pub const fn new_unchecked(buffer: T) -> Packet<T>

Imbue a raw octet buffer with ICMPv4 packet structure.

pub fn new_checked(buffer: T) -> Result<Packet<T>>

Shorthand for a combination of new_unchecked and check_len.

pub fn check_len(&self) -> Result<()>

Ensure that no accessor method will panic if called. Returns Err(Error) if the buffer is too short.

The result of this check is invalidated by calling set_header_len.

pub fn into_inner(self) -> T

Consume the packet, returning the underlying buffer.

pub fn msg_type(&self) -> Message

Return the message type field.

pub fn msg_code(&self) -> u8

Return the message code field.

pub fn checksum(&self) -> u16

Return the checksum field.

pub fn echo_ident(&self) -> u16

Return the identifier field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn echo_seq_no(&self) -> u16

Return the sequence number field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn header_len(&self) -> usize

Return the header length. The result depends on the value of the message type field.

pub fn verify_checksum(&self) -> bool

Validate the header checksum.

Fuzzing

This function always returns true when fuzzing.

impl<'a, T: AsRef<[u8]> + ?Sized> Packet<&'a T>

pub fn data(&self) -> &'a [u8]

Return a pointer to the type-specific data.

impl<T: AsRef<[u8]> + AsMut<[u8]>> Packet<T>

pub fn set_msg_type(&mut self, value: Message)

Set the message type field.

pub fn set_msg_code(&mut self, value: u8)

Set the message code field.

pub fn set_checksum(&mut self, value: u16)

Set the checksum field.

pub fn set_echo_ident(&mut self, value: u16)

Set the identifier field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn set_echo_seq_no(&mut self, value: u16)

Set the sequence number field (for echo request and reply packets).

Panics

This function may panic if this packet is not an echo request or reply packet.

pub fn fill_checksum(&mut self)

Compute and fill in the header checksum.

impl<'a, T: AsRef<[u8]> + AsMut<[u8]> + ?Sized> Packet<&'a mut T>

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

Return a mutable pointer to the type-specific data.

Trait Implementations

impl<T: AsRef<[u8]>> AsRef<[u8]> for Packet<T>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone + AsRef<[u8]>> Clone for Packet<T>

fn clone(&self) -> Packet<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + AsRef<[u8]>> Debug for Packet<T>

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

Formats the value using the given formatter.

impl<'a, T: AsRef<[u8]> + ?Sized> Display for Packet<&'a T>

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

Formats the value using the given formatter.

impl<T: PartialEq + AsRef<[u8]>> PartialEq for Packet<T>

fn eq(&self, other: &Packet<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T: AsRef<[u8]>> PrettyPrint for Packet<T>

fn pretty_print( buffer: &dyn AsRef<[u8]>, f: &mut Formatter<'_>, indent: &mut PrettyIndent, ) -> Result

Write a concise, formatted representation of a packet contained in the provided buffer, and any nested packets it may contain.

impl<T: Eq + AsRef<[u8]>> Eq for Packet<T>

impl<T: AsRef<[u8]>> StructuralPartialEq for Packet<T>