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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
use crate::enums::{
HostNetworkInterfaceMediumType, HostNetworkInterfaceStatus, HostNetworkInterfaceType,
};
use crate::utility::macros::macros::{
get_function_result_bool, get_function_result_number, get_function_result_str,
};
use crate::{HostNetworkInterface, VboxError};
impl HostNetworkInterface {
/// Returns the host network interface name.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let name = network_interface.get_name().unwrap();
pub fn get_name(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetName)
}
/// Returns the host network interface short name.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let name = network_interface.get_short_name().unwrap();
pub fn get_short_name(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetShortName)
}
/// Returns the interface UUID.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let id = network_interface.get_short_name().unwrap();
pub fn get_id(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetId)
}
/// Returns the name of a virtual network the interface gets attached to.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let name = network_interface.get_network_name().unwrap();
pub fn get_network_name(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetNetworkName)
}
/// Specifies whether the DHCP is enabled for the interface.
///
/// # Returns
///
/// Returns a bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let dhcp_enabled = network_interface.get_network_name().unwrap();
pub fn get_dhcp_enabled(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetDHCPEnabled)
}
/// Returns the IP V4 address of the interface.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let ip_address = network_interface.get_ip_address().unwrap();
pub fn get_ip_address(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetIPAddress)
}
/// Returns the network mask of the interface.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let network_mask = network_interface.get_ip_address().unwrap();
pub fn get_network_mask(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetNetworkMask)
}
/// Specifies whether the IP V6 is supported/enabled for the interface.
///
/// # Returns
///
/// Returns a bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let ipv6_supported = network_interface.get_ipv6_supported().unwrap();
pub fn get_ipv6_supported(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetIPV6Supported)
}
/// Returns the IP V6 address of the interface.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let ipv6_address = network_interface.get_ipv6_address().unwrap();
pub fn get_ipv6_address(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetIPV6Address)
}
/// Returns the IP V6 address of the interface.
///
/// # Returns
///
/// Returns u32 success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let ipv6_network_mask_prefix_length = network_interface.get_ipv6_network_mask_prefix_length().unwrap();
pub fn get_ipv6_network_mask_prefix_length(&self) -> Result<u32, VboxError> {
let ipv6_network_mask_prefix_length =
get_function_result_number!(self.object, GetIPV6NetworkMaskPrefixLength, u32)?;
Ok(ipv6_network_mask_prefix_length)
}
/// Returns the IP V6 address of the interface.
///
/// # Returns
///
/// Returns a &str success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let hardware_address = network_interface.get_hardware_address().unwrap();
pub fn get_hardware_address(&self) -> Result<&'static str, VboxError> {
get_function_result_str!(self.object, GetHardwareAddress)
}
/// Type of protocol encapsulation used.
///
/// # Returns
///
/// Returns [`HostNetworkInterfaceMediumType`] success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let ipv6_network_mask_prefix_length = network_interface.get_medium_type().unwrap();
pub fn get_medium_type(&self) -> Result<HostNetworkInterfaceMediumType, VboxError> {
let medium_type = get_function_result_number!(self.object, GetMediumType, u32)?;
Ok(HostNetworkInterfaceMediumType::from(medium_type))
}
/// Status of the interface.
///
/// # Returns
///
/// Returns [`HostNetworkInterfaceStatus`] success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let status = network_interface.get_status().unwrap();
pub fn get_status(&self) -> Result<HostNetworkInterfaceStatus, VboxError> {
let status = get_function_result_number!(self.object, GetStatus, u32)?;
Ok(HostNetworkInterfaceStatus::from(status))
}
/// specifies the host interface type.
///
/// # Returns
///
/// Returns [`HostNetworkInterfaceStatus`] success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let status = network_interface.get_interface_type().unwrap();
pub fn get_interface_type(&self) -> Result<HostNetworkInterfaceType, VboxError> {
let interface_type = get_function_result_number!(self.object, GetInterfaceType, u32)?;
Ok(HostNetworkInterfaceType::from(interface_type))
}
/// Specifies whether the interface is wireless.
///
/// # Returns
///
/// Returns a bool success, or a [`VboxError`] on failure.
///
/// # Example
///
/// ```no_run
///
/// use virtualbox_rs::Host;
///
/// let host = Host::init().unwrap();
/// let network_interfaces = host.get_network_interfaces().unwrap();
/// let network_interface = network_interfaces.get(0).unwrap();
/// let is_wireless = network_interface.get_wireless().unwrap();
pub fn get_wireless(&self) -> Result<bool, VboxError> {
get_function_result_bool!(self.object, GetWireless)
}
}