Skip to main content

IcmpLayer

Struct IcmpLayer 

Source
pub struct IcmpLayer {
    pub index: LayerIndex,
}
Expand description

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§

Source§

impl IcmpLayer

Source

pub fn new(index: LayerIndex) -> Self

Create a new ICMP layer from a layer index.

Source

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

Get the ICMP type.

Source

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

Get the ICMP code.

Source

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

Get the checksum.

Source

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.

Source

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.

Source

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.

Source

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).

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Set the ICMP type.

Source

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

Set the ICMP code.

Source

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

Set the checksum.

Source

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

Set the identifier (for echo, timestamp).

Source

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

Set the sequence number (for echo, timestamp).

Source

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

Set the gateway address (for redirect).

Source

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

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

Source

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

Set the pointer field (for parameter problem).

Source

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

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

Source

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

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

Source

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

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

Source

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

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

Source

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

Generate a summary string for display.

Source

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

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

Source

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

Get field names for this layer.

Source

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

Get a field value by name.

Source

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

Set a field value by name.

Trait Implementations§

Source§

impl Clone for IcmpLayer

Source§

fn clone(&self) -> IcmpLayer

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for IcmpLayer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Layer for IcmpLayer

Source§

fn kind(&self) -> LayerKind

Get the kind of this layer
Source§

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

Get a human-readable summary of this layer
Source§

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

Get the header length for this layer
Source§

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

Compute a hash for packet matching.
Source§

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

Check if this packet answers another packet.
Source§

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

Extract padding from the packet.
Source§

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

Get the list of field names for this layer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V