Struct etherparse::Icmpv4Header

pub struct Icmpv4Header {
    pub icmp_type: Icmpv4Type,
    pub checksum: u16,
}

A header of an ICMPv4 packet.

What is part of the header depends on the ICMPv4 type and code. But usually the static sized elements are part of the header.

Fields

icmp_type: Icmpv4Type

Type & type specific values & code.

checksum: u16

Checksum in the ICMP header.

Implementations

impl Icmpv4Header

pub const MIN_SERIALIZED_SIZE: usize = 8usize

Minimum number of bytes/octets an Icmpv4Header takes up in serialized form.

pub const MAX_SERIALIZED_SIZE: usize = 20usize

Maximum number of bytes/octets an Icmpv4Header takes up in serialized form.

Currently this number is determined by the biggest supported ICMPv4 header type, which is currently the “Timestamp” and “Timestamp Reply Message”.

pub fn new(icmp_type: Icmpv4Type) -> Icmpv4Header

Constructs an Icmpv4Header using the given type and the checksum set to 0.

pub fn with_checksum(icmp_type: Icmpv4Type, payload: &[u8]) -> Icmpv4Header

Creates a Icmpv4Header with a checksum calculated based on the given payload.

pub fn from_slice(slice: &[u8]) -> Result<(Icmpv4Header, &[u8]), ReadError>

Reads an icmp4 header from a slice directly and returns a tuple containing the resulting header & unused part of the slice.

pub fn read<T: Read + Sized>(reader: &mut T) -> Result<Icmpv4Header, ReadError>

Reads an ICMPv4 header from the given reader.

pub fn write<T: Write + Sized>(&self, writer: &mut T) -> Result<(), WriteError>

Write the ICMPv4 header to the given writer.

pub fn header_len(&self) -> usize

Length in bytes/octets of this header type.

pub fn fixed_payload_size(&self) -> Option<usize>

If the ICMP type has a fixed size returns the number of bytes that should be present after the header of this type.

pub fn update_checksum(&mut self, payload: &[u8])

Calculates & updates the checksum in the header.

Note this method assumes that all unused bytes/octets are filled with zeroes.

pub fn to_bytes(&self) -> ArrayVec<u8, { Icmpv4Header::MAX_SERIALIZED_SIZE }>

Converts the header to the on the wire bytes.

Trait Implementations

impl Clone for Icmpv4Header

fn clone(&self) -> Icmpv4Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Icmpv4Header

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

Formats the value using the given formatter.

impl PartialEq<Icmpv4Header> for Icmpv4Header

fn eq(&self, other: &Icmpv4Header) -> 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 Eq for Icmpv4Header

impl StructuralEq for Icmpv4Header

impl StructuralPartialEq for Icmpv4Header