Struct ArpPacket

pub struct ArpPacket {
    pub hw_addr_type: ArpHardwareId,
    pub proto_addr_type: EtherType,
    pub operation: ArpOperation,
    /* private fields */
}

“Address Resolution Protocol” Packet.

Fields

hw_addr_type: ArpHardwareId

Network link protocol type (e.g. ArpHardwareId::ETHERNET).

proto_addr_type: EtherType

Protocol for which the ARP request is intended (e.g. EtherType::IPV4).

operation: ArpOperation

Specifies the operation that the sender is performing

Implementations

impl ArpPacket

pub const MAX_LEN: usize = 1_028usize

Maximum length of an ARP packet in bytes/octets.

This number is calculated by taking the maximum values that hw_addr_size(255/u8::MAX) & proto_addr_size (255/u8::MAX) can take and calculate the maximum packet size from that.

pub const fn new( hw_addr_type: ArpHardwareId, proto_addr_type: EtherType, operation: ArpOperation, sender_hw_addr: &[u8], sender_protocol_addr: &[u8], target_hw_addr: &[u8], target_protocol_addr: &[u8], ) -> Result<ArpPacket, ArpNewError>

Create a new ARP packet with the given values.

pub const unsafe fn new_unchecked( hw_addr_type: ArpHardwareId, proto_addr_type: EtherType, operation: ArpOperation, sender_hw_addr: &[u8], sender_protocol_addr: &[u8], target_hw_addr: &[u8], target_protocol_addr: &[u8], ) -> ArpPacket

Create a new ARP packet with the given values without checking hardware & protocol address sizes.

Safety

The caller must guarantee that

• sender_hw_addr & target_hw_addr have the same length and the length must be smaller or equal than 255.
• sender_protocol_addr & target_protocol_addr have the same length and the length must be smaller or equal than 255.

The guarantees the caller must fulfill are equal to the following preconditions:

• sender_hw_addr.len() == target_hw_addr.len()
• sender_hw_addr.len() <= 255
• target_hw_addr.len() <= 255
• sender_protocol_addr.len() == target_protocol_addr.len()
• sender_protocol_addr.len() <= 255
• target_protocol_addr.len() <= 255

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

Reads an ARP packet from a slice.

pub const fn hw_addr_size(&self) -> u8

Length (in octets) of a hardware address (e.g. 6 for Ethernet).

pub const fn protocol_addr_size(&self) -> u8

Length (in octets) of internetwork addresses (e.g. 4 for IPv4 or 16 for IPv6).

pub const fn sender_hw_addr(&self) -> &[u8]

Sender hardware address (e.g. MAC address).

pub const fn sender_protocol_addr(&self) -> &[u8]

Sender protocol address (e.g. IPv4 address).

pub const fn target_hw_addr(&self) -> &[u8]

Target hardware address (e.g. MAC address).

pub const fn target_protocol_addr(&self) -> &[u8]

Target protocol address (e.g. IPv4 address).

pub const fn set_hw_addrs( &mut self, sender_hw_addr: &[u8], target_hw_addr: &[u8], ) -> Result<(), ArpHwAddrError>

Set the sender & target hardware addresses (e.g. MAC address).

pub const fn set_protocol_addrs( &mut self, sender_protocol_addr: &[u8], target_protocol_addr: &[u8], ) -> Result<(), ArpProtoAddrError>

Set the sender & target protocol addresses (e.g. IPv4 address).

pub fn packet_len(&self) -> usize

Serialized length of this ARP packet.

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

Returns the serialized header.

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

Writes the header to the given writer.

pub fn read<T: Read + Seek + Sized>(reader: &mut T) -> Result<ArpPacket, Error>

Available on crate feature std only.

pub fn try_eth_ipv4(&self) -> Result<ArpEthIpv4Packet, ArpEthIpv4FromError>

Returns an ArpEthIpv4Packet if the current packet is an ethernet & IPv4 ARP packet.

Trait Implementations

impl Clone for ArpPacket

fn clone(&self) -> ArpPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArpPacket

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

Formats the value using the given formatter.

impl From<ArpEthIpv4Packet> for ArpPacket

fn from(value: ArpEthIpv4Packet) -> Self

Converts to this type from the input type.

impl From<ArpPacket> for NetHeaders

fn from(value: ArpPacket) -> Self

Converts to this type from the input type.

impl Hash for ArpPacket

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ArpPacket

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<ArpPacket> for ArpEthIpv4Packet

type Error = ArpEthIpv4FromError

The type returned in the event of a conversion error.

fn try_from(value: ArpPacket) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for ArpPacket