Struct IcmpBuilder 

pub struct IcmpBuilder { /* private fields */ }

Builder for ICMP packets.

Due to ICMP’s type-specific fields, this builder provides factory methods for common ICMP message types rather than a generic constructor.

Implementations

impl IcmpBuilder

pub fn new() -> Self

Create a new ICMP builder with default values (echo request).

pub fn echo_request(id: u16, seq: u16) -> Self

Create an echo request (ping) packet.

Arguments

• id - Identifier
• seq - Sequence number

pub fn echo_reply(id: u16, seq: u16) -> Self

Create an echo reply (pong) packet.

Arguments

• id - Identifier (should match request)
• seq - Sequence number (should match request)

pub fn dest_unreach(code: u8) -> Self

Create a destination unreachable message.

Arguments

• code - Specific unreachable code (0-15)
  • 0: Network unreachable
  • 1: Host unreachable
  • 2: Protocol unreachable
  • 3: Port unreachable
  • 4: Fragmentation needed (use dest_unreach_need_frag for this)

pub fn dest_unreach_need_frag(mtu: u16) -> Self

Create a destination unreachable - fragmentation needed message.

Arguments

• mtu - Next-hop MTU value

pub fn redirect(code: u8, gateway: Ipv4Addr) -> Self

Create a redirect message.

Arguments

• code - Redirect code (0-3)
  • 0: Redirect for network
  • 1: Redirect for host
  • 2: Redirect for TOS and network
  • 3: Redirect for TOS and host
• gateway - Gateway IP address to redirect to

pub fn time_exceeded(code: u8) -> Self

Create a time exceeded message.

Arguments

• code - Time exceeded code
  • 0: TTL exceeded in transit
  • 1: Fragment reassembly time exceeded

pub fn param_problem(ptr: u8) -> Self

Create a parameter problem message.

Arguments

• ptr - Pointer to the problematic byte in the original packet

pub fn source_quench() -> Self

Create a source quench message (deprecated).

pub fn timestamp_request( id: u16, seq: u16, ts_ori: u32, ts_rx: u32, ts_tx: u32, ) -> Self

Create a timestamp request message.

Arguments

• id - Identifier
• seq - Sequence number
• ts_ori - Originate timestamp (milliseconds since midnight UT)
• ts_rx - Receive timestamp (0 for request)
• ts_tx - Transmit timestamp (0 for request)

pub fn timestamp_reply( id: u16, seq: u16, ts_ori: u32, ts_rx: u32, ts_tx: u32, ) -> Self

Create a timestamp reply message.

Arguments

• id - Identifier (should match request)
• seq - Sequence number (should match request)
• ts_ori - Originate timestamp from request
• ts_rx - Receive timestamp (when request was received)
• ts_tx - Transmit timestamp (when reply is sent)

pub fn address_mask_request(id: u16, seq: u16) -> Self

Create an address mask request message.

Arguments

• id - Identifier
• seq - Sequence number

pub fn address_mask_reply(id: u16, seq: u16, mask: Ipv4Addr) -> Self

Create an address mask reply message.

Arguments

• id - Identifier (should match request)
• seq - Sequence number (should match request)
• mask - Address mask

pub fn icmp_type(self, t: u8) -> Self

Set the ICMP type manually (use factory methods instead when possible).

pub fn code(self, c: u8) -> Self

Set the ICMP code manually.

pub fn checksum(self, csum: u16) -> Self

Set the checksum manually.

If not set, the checksum will be calculated automatically.

pub fn chksum(self, csum: u16) -> Self

Alias for checksum (Scapy compatibility).

pub fn enable_auto_checksum(self) -> Self

Enable automatic checksum calculation (default).

pub fn disable_auto_checksum(self) -> Self

Disable automatic checksum calculation.

pub fn payload<T: Into<Vec<u8>>>(self, data: T) -> Self

Set the payload data.

pub fn append_payload<T: AsRef<[u8]>>(self, data: T) -> Self

Append to the payload data.

pub fn packet_size(&self) -> usize

Get the total packet size (header + optional timestamp + payload).

pub fn header_size(&self) -> usize

Get the header size (8 bytes for most, 20 for timestamp).

pub fn build(&self) -> Vec<u8>

Build the ICMP packet into a new buffer.

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

Build the ICMP packet into an existing buffer.

pub fn build_header(&self) -> Vec<u8>

Build just the ICMP header (without payload).

Trait Implementations

impl Clone for IcmpBuilder

fn clone(&self) -> IcmpBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IcmpBuilder

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

Formats the value using the given formatter.

impl Default for IcmpBuilder

fn default() -> Self

Returns the “default value” for a type.