mac-sys-info 0.1.13

CLI + Library to get detailed information about your Mac system. Including CPU, Cache (L1-L3), Memory, and more.
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

/*
MIT License

Copyright (c) 2020 Philipp Schuster

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

//! Library to get Mac-specific system info. The information is retrieved from the `$ sysctl -a`
//! command. It gives you structured access to system info as well as raw access to all keys.

#[macro_use]
extern crate log;

use crate::error::MacSysInfoError;
use unix_exec_output_catcher::{fork_exec_and_catch, OCatchStrategy};
use crate::parse::{parse_sysctl_line};
use crate::structs::MacSysInfo;
use std::collections::{BTreeMap};

pub mod error;
pub mod generated_sysctl_keys;
mod parse;
pub mod structs;

/// Executes the "sysctl" binary with the "-a" option in a child process
/// and captures it's output.
fn fetch_info_from_sysctl() -> Result<Vec<(String, String)>, MacSysInfoError> {
    let res = fork_exec_and_catch("sysctl", vec!["sysctl", "-a"], OCatchStrategy::StdSeparately)
        .map_err(|inner| MacSysInfoError::CantFetchData(inner))?;
    let res = res.stdout_lines().ok_or(MacSysInfoError::NoCapturedOutput)?;
    let res = res.iter().map(|s| s.as_str()).collect::<Vec<&str>>();
    let key_value_vector = res.iter()
        .map(|s| parse_sysctl_line(s))
        .collect::<Vec<(String, String)>>();

    Ok(key_value_vector)
}

/// Returns system information about your Mac. The information is retrieved
/// from the `sysctl -a` command.
pub fn get_mac_sys_info() -> Result<MacSysInfo, MacSysInfoError> {
    let key_value_vector = fetch_info_from_sysctl()?;

    // build the raw string to string map of all supported information
    let mut all_keys = BTreeMap::new();
    key_value_vector.into_iter()
        .for_each(|(sys_key, sys_value)| {
            all_keys.insert(sys_key, sys_value);
        });

    Ok(
        MacSysInfo::new(all_keys)?
    )
}

#[cfg(test)]
mod tests {
    use crate::get_mac_sys_info;

    #[test]
    fn test_get_sys_info() {
        let _res = get_mac_sys_info();
    }
}