Struct libarp::client::ArpClient

pub struct ArpClient { /* fields omitted */ }

Struct that encapsulates interaction with (R)ARP messages, such as sending and receiving.

Implementations

impl ArpClient

pub fn new() -> Self

Create an ARP client on a guessed, “best-suited” interface.

pub fn new_with_iface_name(iface_name: &str) -> Option<Self>

Create an ARP client on the interface with the name iface_name.

pub fn new_with_iface(interface: &Interface) -> Self

Create an ARP client on the interface given.

pub async fn send_message(
    &mut self,
    timeout: Option<Duration>,
    message: ArpMessage
) -> Result<ArpMessage, Error>

Send an ARP message with the given timeout. Returns the next ARP message received. (must not necessarily be related to your message sent)

pub async fn send_message_with_check<T>(
    &mut self,
    timeout: Option<Duration>,
    message: ArpMessage,
    check_answer: &dyn Fn(ArpMessage) -> Option<T>
) -> Result<T, Error>

Send an ARP message with the given timeout, and perform an arbitrary check check_answer on the answer. Using check_answer, you can check if the received tmessage is related to your previously sent message if needed. Returns the first ARP message received that satisfies check_answer.

pub async fn ip_to_mac(
    &mut self,
    ip_addr: Ipv4Addr,
    timeout: Option<Duration>
) -> Result<MacAddr, Error>

Resolves a given ip_addr to a MAC address. To achieve this, sends an ARP request with a timeout.

pub async fn mac_to_ip(
    &mut self,
    mac_addr: MacAddr,
    timeout: Option<Duration>
) -> Result<Ipv4Addr, Error>

Resolves a given mac_addr to an IPv4 address. To achieve this, sends an RARP request with a timeout.

pub async fn send(&self, arp_message: &ArpMessage) -> Result<(), Error>

Sends arp_message on the interface belonging to this client.

pub async fn receive_next(&mut self) -> Option<ArpMessage>

Returns the next ARP message received. Doesn’t return if no ARP message is received.