getifs 0.6.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

use std::io;

use smallvec_wrapper::SmallVec;

use super::{os, IfAddr, Ifv4Addr, Ifv6Addr};

/// Returns all gateway IP addresses (both IPv4 and IPv6) configured on the system.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::gateway_addrs;
///
/// let gateways = gateway_addrs().unwrap();
/// for gw in gateways {
///   println!("Gateway: {}", gw);
/// }
/// ```
pub fn gateway_addrs() -> io::Result<SmallVec<IfAddr>> {
  os::gateway_addrs()
}

/// Returns all IPv4 gateway addresses configured on the system.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::gateway_ipv4_addrs;
///
/// let gateways = gateway_ipv4_addrs().unwrap();
/// for gw in gateways {
///   println!("IPv4 Gateway: {}", gw);
/// }
/// ```
pub fn gateway_ipv4_addrs() -> io::Result<SmallVec<Ifv4Addr>> {
  os::gateway_ipv4_addrs()
}

/// Returns all IPv6 gateway addresses configured on the system.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::gateway_ipv6_addrs;
///
/// let gateways = gateway_ipv6_addrs().unwrap();
/// for gw in gateways {
///   println!("IPv6 Gateway: {}", gw);
/// }
/// ```
pub fn gateway_ipv6_addrs() -> io::Result<SmallVec<Ifv6Addr>> {
  os::gateway_ipv6_addrs()
}

/// Returns all gateway IP addresses (both IPv4 and IPv6) configured on the system
/// that match the given filter.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::{gateway_addrs_by_filter, IfAddr};
/// use std::net::IpAddr;
///
/// let gateways = gateway_addrs_by_filter(|ip| {
///   match ip {
///     IpAddr::V4(_) => true,
///     IpAddr::V6(_) => false,
///   }
/// }).unwrap();
///
/// for gw in gateways {
///   println!("Gateway: {}", gw);
/// }
/// ```
pub fn gateway_addrs_by_filter<F>(f: F) -> io::Result<SmallVec<IfAddr>>
where
  F: FnMut(&std::net::IpAddr) -> bool,
{
  os::gateway_addrs_by_filter(f)
}

/// Returns all IPv4 gateway addresses configured on the system
/// that match the given filter.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::gateway_ipv4_addrs_by_filter;
///
/// let gateways = gateway_ipv4_addrs_by_filter(|ip| {
///  ip.is_private()
/// }).unwrap();
///
/// for gw in gateways {
///   println!("IPv4 Gateway: {}", gw);
/// }
/// ```
pub fn gateway_ipv4_addrs_by_filter<F>(f: F) -> io::Result<SmallVec<Ifv4Addr>>
where
  F: FnMut(&std::net::Ipv4Addr) -> bool,
{
  os::gateway_ipv4_addrs_by_filter(f)
}

/// Returns all IPv6 gateway addresses configured on the system
/// that match the given filter.
/// Only returns addresses from interfaces that have valid routes and
/// excludes any addresses that are not configured as gateways.
///
/// ## Example
///
/// ```rust
/// use getifs::gateway_ipv6_addrs_by_filter;
///
/// let gateways = gateway_ipv6_addrs_by_filter(|ip| {
///   true
/// }).unwrap();
///
/// for gw in gateways {
///   println!("IPv6 Gateway: {}", gw);
/// }
/// ```
pub fn gateway_ipv6_addrs_by_filter<F>(f: F) -> io::Result<SmallVec<Ifv6Addr>>
where
  F: FnMut(&std::net::Ipv6Addr) -> bool,
{
  os::gateway_ipv6_addrs_by_filter(f)
}