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
82

/*
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.
*/

//! CPU-Architecture info.

use derive_more::Display as DeriveMoreDisplay;
use serde::{Serialize};
use std::collections::BTreeMap;
use crate::error::MacSysInfoError;
use crate::generated_sysctl_keys::SysctlKey;

/// Information about the CPU architecture. Because this library
/// is Mac-specific, there is only X86_64 (since the beginning)
/// and Apple Silicon (AppleSi) since late 2020.
#[derive(Debug, Serialize, DeriveMoreDisplay)]
#[allow(non_camel_case_types)]
#[allow(dead_code)]
pub enum CpuArchitectureInfo {
    /// x86_64
    x86_64,
    /// Apple Silicon
    AppleSi,
}


#[allow(dead_code)]
impl CpuArchitectureInfo {

    /// Constructor
    pub(crate) fn new(sysinfo: &BTreeMap<String, String>) -> Result<Self, MacSysInfoError> {
        CpuArchitectureInfo::determine_architecture(sysinfo)
    }

    /// Reads the CPU architecture from the "sysctl -a" output.
    pub(crate) fn determine_architecture(sysinfo: &BTreeMap<String, String>) -> Result<CpuArchitectureInfo, MacSysInfoError> {
        let is_x86 = sysinfo.get(SysctlKey::KernVersion.name())
            .ok_or(MacSysInfoError::KeyNotFound(SysctlKey::KernVersion))?
            .to_lowercase()
            .contains("x86_64");
        if is_x86 {
            Ok(CpuArchitectureInfo::x86_64)
        } else {
            Ok(CpuArchitectureInfo::AppleSi)
        }
    }

    /// Convenient getter to check if the current system is a x86_64 system.
    pub fn is_x86_64(&self) -> bool {
        match self {
            CpuArchitectureInfo::x86_64 => { true }
            CpuArchitectureInfo::AppleSi => { false }
        }
    }

    /// Convenient getter to check if the current system is a Apple Silicon system.
    pub fn is_apple_si(&self) -> bool {
        !self.is_x86_64()
    }
}