Struct etherparse::Icmpv4Slice

pub struct Icmpv4Slice<'a> { /* private fields */ }

A slice containing an ICMPv4 network package.

Struct allows the selective read of fields in the ICMPv4 packet.

Implementations

impl<'a> Icmpv4Slice<'a>

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

Creates a slice containing an ICMPv4 packet.

Errors

The function will return an Err ReadError::UnexpectedEndOfSlice if the given slice is too small.

pub fn header(&self) -> Icmpv4Header

Decode the header values into an Icmpv4Header struct.

pub fn header_len(&self) -> usize

Number of bytes/octets that will be converted into a Icmpv4Header when Icmpv4Slice::header gets called.

pub fn icmp_type(&self) -> Icmpv4Type

Decode the header values (excluding the checksum) into an Icmpv4Type enum.

pub fn type_u8(&self) -> u8

Returns “type” value in the ICMPv4 header.

pub fn code_u8(&self) -> u8

Returns “code” value in the ICMPv4 header.

pub fn checksum(&self) -> u16

Returns “checksum” value in the ICMPv4 header.

pub fn bytes5to8(&self) -> [u8; 4]

Returns the bytes from position 4 till and including the 8th position in the ICMPv4 header.

These bytes located at th 5th, 6th, 7th and 8th position of the ICMP packet can depending on the ICMPv4 type and code contain additional data.

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

Returns a slice to the bytes not covered by .header().

The contents of the slice returned by payload() depends on the type and code of the ICMP packet:

.header().icmp_type or .icmp_type()	Payload Content
Icmpv4Type::EchoReply Icmpv4Type::EchoRequest	Data part of the echo message
Icmpv4Type::DestinationUnreachable Icmpv4Type::Redirect Icmpv4Type::TimeExceeded Icmpv4Type::ParameterProblem	Internet Header + 64 bits of Original Data Datagram causing the ICMP message
Icmpv4Type::TimestampRequest Icmpv4Type::TimestampReply	Nothing
Icmpv4Type::Unknown	Everything after the 8th byte/octet of the ICMP packet.

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

Returns the slice containing the ICMPv4 packet.

Trait Implementations

impl<'a> Clone for Icmpv4Slice<'a>

fn clone(&self) -> Icmpv4Slice<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Icmpv4Slice<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq<Icmpv4Slice<'a>> for Icmpv4Slice<'a>

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

impl<'a> StructuralEq for Icmpv4Slice<'a>

impl<'a> StructuralPartialEq for Icmpv4Slice<'a>