getifs 0.5.0

Cross-platform enumeration of network interfaces and their MTU, gateway, multicast, and local/private/public IP addresses.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use core::net::IpAddr;
use std::{
  io,
  net::{Ipv4Addr, Ipv6Addr},
};

use super::interfaces;

fn interface_not_found_for_ip() -> io::Error {
  io::Error::new(io::ErrorKind::Other, "interface not found")
}

/// Get the MTU of the given [`IpAddr`].
///
/// ## Example
///
/// ```rust
/// use getifs::get_ip_mtu;
///
/// let mtu = get_ip_mtu("127.0.0.1".parse().unwrap()).unwrap();
/// println!("MTU: {}", mtu);
/// ```
pub fn get_ip_mtu(ip: IpAddr) -> io::Result<u32> {
  interfaces().and_then(|ifis| {
    for iface in ifis {
      match iface.addrs_by_filter(|addr| ip.eq(addr)) {
        Ok(addrs) => {
          if !addrs.is_empty() {
            return Ok(iface.mtu());
          }
        }
        Err(_) => continue,
      }
    }

    Err(interface_not_found_for_ip())
  })
}

/// Get the MTU of the given [`Ipv4Addr`].
///
/// ## Example
///
/// ```rust
/// use std::net::Ipv4Addr;
/// use getifs::get_ipv4_mtu;
///
/// let mtu = get_ipv4_mtu(Ipv4Addr::LOCALHOST).unwrap();
/// println!("MTU: {}", mtu);
/// ```
pub fn get_ipv4_mtu(ip: Ipv4Addr) -> io::Result<u32> {
  interfaces().and_then(|ifis| {
    for iface in ifis {
      match iface.ipv4_addrs_by_filter(|addr| ip.eq(addr)) {
        Ok(addrs) => {
          if !addrs.is_empty() {
            return Ok(iface.mtu());
          }
        }
        Err(_) => continue,
      }
    }

    Err(interface_not_found_for_ip())
  })
}

/// Get the MTU of the given [`Ipv6Addr`].
///
/// ## Example
///
/// ```rust
/// use std::net::Ipv6Addr;
/// use getifs::get_ipv6_mtu;
///
/// let mtu = get_ipv6_mtu(Ipv6Addr::LOCALHOST).unwrap();
/// println!("MTU: {}", mtu);
/// ```
pub fn get_ipv6_mtu(ip: Ipv6Addr) -> io::Result<u32> {
  interfaces().and_then(|ifis| {
    for iface in ifis {
      match iface.ipv6_addrs_by_filter(|addr| ip.eq(addr)) {
        Ok(addrs) => {
          if !addrs.is_empty() {
            return Ok(iface.mtu());
          }
        }
        Err(_) => continue,
      }
    }

    Err(interface_not_found_for_ip())
  })
}