Struct IcmpLayer 

pub struct IcmpLayer {
    pub index: LayerIndex,
}

ICMP layer representation.

ICMP is the control protocol for IP, defined in RFC 792. The header format varies based on message type:

Base header (all types):
 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|     Type      |     Code      |          Checksum             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                    (Type-specific data)                       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Echo/Echo Reply (type 0, 8):
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|          Identifier           |        Sequence Number        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Redirect (type 5):
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                     Gateway IP Address                        |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Fields

index: LayerIndex

Implementations

impl IcmpLayer

pub fn new(index: LayerIndex) -> Self

Create a new ICMP layer from a layer index.

pub fn icmp_type(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the ICMP type.

pub fn code(&self, buf: &[u8]) -> Result<u8, FieldError>

Get the ICMP code.

pub fn checksum(&self, buf: &[u8]) -> Result<u16, FieldError>

Get the checksum.

pub fn id(&self, buf: &[u8]) -> Result<Option<u16>, FieldError>

Get the identifier (for echo, timestamp).

Returns None if this ICMP type doesn’t have an ID field.

pub fn seq(&self, buf: &[u8]) -> Result<Option<u16>, FieldError>

Get the sequence number (for echo, timestamp).

Returns None if this ICMP type doesn’t have a sequence field.

pub fn gateway(&self, buf: &[u8]) -> Result<Option<Ipv4Addr>, FieldError>

Get the gateway address (for redirect messages).

Returns None if this is not a redirect message.

pub fn next_hop_mtu(&self, buf: &[u8]) -> Result<Option<u16>, FieldError>

Get the next-hop MTU (for destination unreachable, fragmentation needed).

Returns None if this is not a dest unreachable with code 4 (fragmentation needed).

pub fn ptr(&self, buf: &[u8]) -> Result<Option<u8>, FieldError>

Get the pointer field (for parameter problem).

Returns None if this is not a parameter problem message.

pub fn ts_ori(&self, buf: &[u8]) -> Result<Option<u32>, FieldError>

Get the originate timestamp (for timestamp request/reply).

Returns None if this is not a timestamp message. Timestamp is in milliseconds since midnight UT.

pub fn ts_rx(&self, buf: &[u8]) -> Result<Option<u32>, FieldError>

Get the receive timestamp (for timestamp request/reply).

Returns None if this is not a timestamp message. Timestamp is in milliseconds since midnight UT.

pub fn ts_tx(&self, buf: &[u8]) -> Result<Option<u32>, FieldError>

Get the transmit timestamp (for timestamp request/reply).

Returns None if this is not a timestamp message. Timestamp is in milliseconds since midnight UT.

pub fn addr_mask(&self, buf: &[u8]) -> Result<Option<Ipv4Addr>, FieldError>

Get the address mask (for address mask request/reply).

Returns None if this is not an address mask message.

pub fn set_type(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the ICMP type.

pub fn set_code(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the ICMP code.

pub fn set_checksum(&self, buf: &mut [u8], value: u16) -> Result<(), FieldError>

Set the checksum.

pub fn set_id(&self, buf: &mut [u8], value: u16) -> Result<(), FieldError>

Set the identifier (for echo, timestamp).

pub fn set_seq(&self, buf: &mut [u8], value: u16) -> Result<(), FieldError>

Set the sequence number (for echo, timestamp).

pub fn set_gateway( &self, buf: &mut [u8], value: Ipv4Addr, ) -> Result<(), FieldError>

Set the gateway address (for redirect).

pub fn set_next_hop_mtu( &self, buf: &mut [u8], value: u16, ) -> Result<(), FieldError>

Set the next-hop MTU (for destination unreachable, fragmentation needed).

pub fn set_ptr(&self, buf: &mut [u8], value: u8) -> Result<(), FieldError>

Set the pointer field (for parameter problem).

pub fn set_ts_ori(&self, buf: &mut [u8], value: u32) -> Result<(), FieldError>

Set the originate timestamp (for timestamp request/reply).

pub fn set_ts_rx(&self, buf: &mut [u8], value: u32) -> Result<(), FieldError>

Set the receive timestamp (for timestamp request/reply).

pub fn set_ts_tx(&self, buf: &mut [u8], value: u32) -> Result<(), FieldError>

Set the transmit timestamp (for timestamp request/reply).

pub fn set_addr_mask( &self, buf: &mut [u8], value: Ipv4Addr, ) -> Result<(), FieldError>

Set the address mask (for address mask request/reply).

pub fn summary(&self, buf: &[u8]) -> String

Generate a summary string for display.

pub fn header_len(&self, buf: &[u8]) -> usize

Get the ICMP header length (variable based on type).

pub fn field_names(&self) -> &'static [&'static str]

Get field names for this layer.

pub fn get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

pub fn set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

Trait Implementations

impl Clone for IcmpLayer

fn clone(&self) -> IcmpLayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcmpLayer

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

Formats the value using the given formatter.

impl From<IcmpLayer> for LayerEnum

fn from(v: IcmpLayer) -> LayerEnum

Converts to this type from the input type.

impl Layer for IcmpLayer

fn kind(&self) -> LayerKind

Get the kind of this layer

fn summary(&self, data: &[u8]) -> String

Get a human-readable summary of this layer

fn header_len(&self, data: &[u8]) -> usize

Get the header length for this layer

fn hashret(&self, data: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn answers(&self, data: &[u8], other: &Self, other_data: &[u8]) -> bool

Check if this packet answers another packet.

fn extract_padding<'a>(&self, data: &'a [u8]) -> (&'a [u8], &'a [u8])

Extract padding from the packet.

fn field_names(&self) -> &'static [&'static str]

Get the list of field names for this layer

impl LayerDispatch for IcmpLayer

fn dispatch_kind(&self) -> LayerKind

Get the kind of this layer.

fn dispatch_index(&self) -> &LayerIndex

Get the layer index (start/end offsets).

fn dispatch_summary(&self, buf: &[u8]) -> String

Get a human-readable summary.

fn dispatch_header_len(&self, buf: &[u8]) -> usize

Get the header length in bytes.

fn dispatch_hashret(&self, buf: &[u8]) -> Vec<u8>

Compute a hash for packet matching.

fn dispatch_field_names(&self) -> &'static [&'static str]

Get field names for this layer type.

fn dispatch_get_field( &self, buf: &[u8], name: &str, ) -> Option<Result<FieldValue, FieldError>>

Get a field value by name.

fn dispatch_set_field( &self, buf: &mut [u8], name: &str, value: FieldValue, ) -> Option<Result<(), FieldError>>

Set a field value by name.

fn dispatch_show_fields(&self, buf: &[u8]) -> Vec<(&'static str, String)>

Get show-fields output.

impl TryInto<IcmpLayer> for LayerEnum

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<IcmpLayer, <Self as TryInto<IcmpLayer>>::Error>

Performs the conversion.