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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
use crate::{GuidWrapper, IfLuid, IpGatewayInfo, IphlpNetworkAdapterInfo, MacAddress};
use std::net::IpAddr;
use windows::Win32::NetworkManagement::Ndis::{NDIS_MEDIUM, NDIS_PHYSICAL_MEDIUM};
impl IphlpNetworkAdapterInfo {
/// Returns the index of the IPv4 interface.
///
/// # Examples
///
/// ```rust,ignore
/// let if_index = adapter_info.if_index();
/// ```
pub fn if_index(&self) -> u32 {
self.if_index
}
/// Returns the interface index for the IPv6 IP address.
/// This member is zero if IPv6 is not available on the interface.
///
/// # Examples
///
/// ```rust,ignore
/// let ipv6_if_index = adapter_info.ipv6_if_index();
/// ```
pub fn ipv6_if_index(&self) -> u32 {
self.ipv6_if_index
}
/// Returns a reference to the name of the adapter.
/// Unlike an adapter's friendly name, the adapter name specified in `adapter_name_`
/// is permanent and cannot be modified by the user.
///
/// # Examples
///
/// ```rust,ignore
/// let adapter_name = adapter_info.adapter_name();
/// ```
pub fn adapter_name(&self) -> &String {
&self.adapter_name
}
/// Returns a reference to the name of the underlying hardware adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let true_adapter_name = adapter_info.true_adapter_name();
/// ```
pub fn true_adapter_name(&self) -> &GuidWrapper {
&self.true_adapter_name
}
/// Returns a reference to the description for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let description = adapter_info.description();
/// ```
pub fn description(&self) -> &String {
&self.description
}
/// Returns a reference to the user-friendly name for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let friendly_name = adapter_info.friendly_name();
/// ```
pub fn friendly_name(&self) -> &String {
&self.friendly_name
}
/// Returns a reference to the list of IP unicast addresses for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let unicast_address_list = adapter_info.unicast_address_list();
/// ```
pub fn unicast_address_list(&self) -> &Vec<IpAddr> {
&self.unicast_address_list
}
/// Returns a list of unicast addresses with their prefix lengths for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let addresses_with_prefix = adapter_info.unicast_address_list_with_prefix();
/// ```
pub fn unicast_address_list_with_prefix(&self) -> Vec<(IpAddr, u8)> {
self.get_unicast_addresses_with_prefix()
}
/// Returns a reference to the list of DNS server addresses for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let dns_server_address_list = adapter_info.dns_server_address_list();
/// ```
pub fn dns_server_address_list(&self) -> &Vec<IpAddr> {
&self.dns_server_address_list
}
/// Returns a reference to the list of gateways for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let gateway_address_list = adapter_info.gateway_address_list();
/// ```
pub fn gateway_address_list(&self) -> &Vec<IpGatewayInfo> {
&self.gateway_address_list
}
/// Returns a reference to the Media Access Control (MAC) address for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let physical_address = adapter_info.physical_address();
/// ```
pub fn physical_address(&self) -> &MacAddress {
&self.physical_address
}
/// Returns the maximum transmission unit (MTU) size, in bytes.
///
/// # Examples
///
/// ```rust,ignore
/// let mtu = adapter_info.mtu();
/// ```
pub fn mtu(&self) -> u16 {
self.mtu
}
/// Returns the interface type as defined by the Internet Assigned Names Authority (IANA).
/// Possible values for the interface type are listed in the `Ipifcons.h` header file.
///
/// # Examples
///
/// ```rust,ignore
/// let if_type = adapter_info.if_type();
/// ```
pub fn if_type(&self) -> u32 {
self.if_type
}
/// Returns the current speed in bits per second of the transmit link for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let transmit_link_speed = adapter_info.transmit_link_speed();
/// ```
pub fn transmit_link_speed(&self) -> u64 {
self.transmit_link_speed
}
/// Returns the current speed in bits per second of the receive link for the adapter.
///
/// # Examples
///
/// ```rust,ignore
/// let receive_link_speed = adapter_info.receive_link_speed();
/// ```
pub fn receive_link_speed(&self) -> u64 {
self.receive_link_speed
}
/// Returns the interface LUID for the adapter address.
///
/// # Examples
///
/// ```rust,ignore
/// let luid = adapter_info.luid();
/// ```
pub fn luid(&self) -> &IfLuid {
&self.luid
}
/// Returns the NDIS media type for the interface.
/// This member can be one of the values from the `NDIS_MEDIUM`
/// enumeration type defined in the `Ntddndis.h` header file.
///
/// # Examples
///
/// ```rust,ignore
/// let media_type = adapter_info.media_type();
/// ```
pub fn media_type(&self) -> &NDIS_MEDIUM {
&self.media_type
}
/// Returns the NDIS physical medium type.
/// This member can be one of the values from the `NDIS_PHYSICAL_MEDIUM`
/// enumeration type defined in the `Ntddndis.h` header file.
///
/// # Examples
///
/// ```rust,ignore
/// let physical_medium_type = adapter_info.physical_medium_type();
/// ```
pub fn physical_medium_type(&self) -> &NDIS_PHYSICAL_MEDIUM {
&self.physical_medium_type
}
/// If `physical_medium_type_` is `NdisPhysicalMediumUnspecified` (virtual network interface on top of the real one),
/// this one may contain real physical media.
///
/// # Examples
///
/// ```rust,ignore
/// let true_medium_type = adapter_info.true_medium_type();
/// ```
pub fn true_medium_type(&self) -> &NDIS_PHYSICAL_MEDIUM {
&self.true_medium_type
}
/// Returns the NDISWANIP associated MAC address.
///
/// # Examples
///
/// ```rust,ignore
/// let ndis_wan_ip_link = adapter_info.ndis_wan_ip_link();
/// ```
pub fn ndis_wan_ip_link(&self) -> &MacAddress {
&self.ndis_wan_ip_link
}
/// Returns the NDISWANIPV6 associated MAC address.
///
/// # Examples
///
/// ```rust,ignore
/// let ndis_wan_ipv6_link = adapter_info.ndis_wan_ipv6_link();
/// ```
pub fn ndis_wan_ipv6_link(&self) -> &MacAddress {
&self.ndis_wan_ipv6_link
}
}