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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

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

macro_rules! if_addr {
  ($kind:literal) => {
    paste::paste! {
      #[doc = "An interface IP" $kind " address."]
      #[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
      pub struct [<If $kind Addr>] {
        index: u32,
        addr: [<Ip $kind Addr>],
      }

      impl core::fmt::Display for [<If $kind Addr>] {
        fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
          write!(f, "{} ({})", self.addr, self.index)
        }
      }

      impl core::ops::Deref for [<If $kind Addr>] {
        type Target = [<Ip $kind Addr>];

        #[inline]
        fn deref(&self) -> &Self::Target {
          &self.addr
        }
      }

      impl [<If $kind Addr>] {
        #[doc = "Creates a new `If" $kind "Addr` from an [`Ip" $kind "Addr`]."]
        #[inline]
        pub const fn new(index: u32, addr: [<Ip $kind Addr>]) -> Self {
          Self {
            index,
            addr,
          }
        }

        /// Returns the index of the interface.
        #[inline]
        pub const fn index(&self) -> u32 {
          self.index
        }

        /// Returns the name of the interface.
        ///
        /// This method will invoke the `if_indextoname` function to get the name of the interface internally.
        pub fn name(&self) -> std::io::Result<smol_str::SmolStr> {
          crate::idx_to_name::ifindex_to_name(self.index)
        }

        /// Returns the address of the interface.
        #[inline]
        pub const fn addr(&self) -> [<Ip $kind Addr>] {
          self.addr
        }
      }
    }
  };
}

if_addr!("v4");
if_addr!("v6");

/// An interface address.
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
pub enum IfAddr {
  /// An IPv4 interface address.
  V4(Ifv4Addr),
  /// An IPv6 interface address.
  V6(Ifv6Addr),
}

impl core::fmt::Display for IfAddr {
  fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    match self {
      Self::V4(addr) => write!(f, "{addr}"),
      Self::V6(addr) => write!(f, "{addr}"),
    }
  }
}

impl From<Ifv4Addr> for IfAddr {
  fn from(value: Ifv4Addr) -> Self {
    Self::V4(value)
  }
}

impl From<Ifv6Addr> for IfAddr {
  fn from(value: Ifv6Addr) -> Self {
    Self::V6(value)
  }
}

impl IfAddr {
  /// Creates a new `IfAddr` from an [`IpAddr`].
  #[inline]
  pub const fn new(index: u32, addr: IpAddr) -> Self {
    match addr {
      IpAddr::V4(addr) => Self::V4(Ifv4Addr::new(index, addr)),
      IpAddr::V6(addr) => Self::V6(Ifv6Addr::new(index, addr)),
    }
  }

  /// Returns the index of the interface.
  #[inline]
  pub const fn index(&self) -> u32 {
    match self {
      Self::V4(addr) => addr.index(),
      Self::V6(addr) => addr.index(),
    }
  }

  /// Returns the name of the interface.
  ///
  /// This method will invoke the `if_indextoname` function to get the name of the interface internally.
  pub fn name(&self) -> std::io::Result<smol_str::SmolStr> {
    crate::idx_to_name::ifindex_to_name(self.index())
  }

  /// Returns the address of the interface.
  #[inline]
  pub const fn addr(&self) -> IpAddr {
    match self {
      Self::V4(addr) => IpAddr::V4(addr.addr()),
      Self::V6(addr) => IpAddr::V6(addr.addr()),
    }
  }
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn ifv4addr() {
    let addr = Ifv4Addr::new(1, Ipv4Addr::new(127, 0, 0, 1));
    assert_eq!(addr.index(), 1);
    assert_eq!(addr.addr(), Ipv4Addr::new(127, 0, 0, 1));
    assert!(addr.name().is_ok());
    let _ = addr.is_private();
  }

  #[test]
  fn ifv6addr() {
    let addr = Ifv6Addr::new(1, Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
    assert_eq!(addr.index(), 1);
    assert_eq!(addr.addr(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
    assert!(addr.name().is_ok());
    let _ = addr.is_loopback();
  }

  #[test]
  fn ifaddr() {
    let addr = IfAddr::new(1, IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
    assert_eq!(addr.index(), 1);
    assert_eq!(addr.addr(), IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)));
    assert!(addr.name().is_ok());
    println!("{addr}");

    let addr = IfAddr::new(1, IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)));
    assert_eq!(addr.index(), 1);
    assert_eq!(
      addr.addr(),
      IpAddr::V6(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1))
    );
    assert!(addr.name().is_ok());
    println!("{addr}");
  }
}