piface 0.1.1

Attempts to determine the default route and gets related interface information
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

//!interface name, mac address, and the related default route
use crate::{gateway::DefaultRoute, Result};
use eui48::MacAddress;
#[cfg(target_os = "windows")]
#[path = "win.rs"]
mod os;

#[cfg(any(target_os = "linux", target_os = "macos", target_os = "freebsd"))]
#[path = "nix.rs"]
mod os;

/// Underlying function call specific to the operating system to pull a mac address for a passed interface
///
/// On *nix based machines the nix crate will be used
/// On windows machines wmic commands will be used
pub use self::os::get_mac;

/// This contains the interface name, mac address, and the related default route
///
/// The interface name will use the friendly name on windows machines
/// The mac address will be parsed for standardization
///
/// # Examples
///
/// ```
/// # use piface::Result;
/// use piface::PrimaryInterface;
///
/// # fn try_main() -> Result<()> {
/// let iface = PrimaryInterface::load()?;
/// println!("{:#?}", iface);
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Default, Clone)]
pub struct PrimaryInterface {
    pub name: String,
    pub mac_address: MacAddress,
    pub default_route: DefaultRoute,
}

impl PrimaryInterface {
    /// Instantiates a new PrimaryInterface and calls the get method
    pub fn load() -> Result<Self> {
        let mut new = PrimaryInterface::default();
        new.get()?;
        Ok(new)
    }

    /// Attempts to get interface information on *nix based machines
    #[cfg(any(target_os = "linux", target_os = "macos", target_os = "freebsd"))]
    fn get(&mut self) -> Result<()> {
        let gateway = DefaultRoute::load()?;
        if gateway.interface.is_some() {
            self.default_route = gateway.clone();
            self.name = gateway.interface.unwrap();
            let mac = get_mac(&self.name)?;
            if let Some(mac) = mac {
                self.mac_address = mac;
            }
        }
        Ok(())
    }

    /// Attempts to get interface information on windows based machines
    #[cfg(target_os = "windows")]
    fn get(&mut self) -> Result<()> {
        let gateway = DefaultRoute::load()?;
        if gateway.interface.is_some() {
            self.default_route = gateway.clone();
            self.name = gateway.interface.unwrap();
            let mac = get_mac()?;
            if let Some(mac) = mac {
                self.mac_address = mac;
            }
        }
        Ok(())
    }
}