mac_sys_info/structs/
mem_info.rs

1/*
2MIT License
3
4Copyright (c) 2020 Philipp Schuster
5
6Permission is hereby granted, free of charge, to any person obtaining a copy
7of this software and associated documentation files (the "Software"), to deal
8in the Software without restriction, including without limitation the rights
9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in all
14copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22SOFTWARE.
23*/
24
25//! Memory info.
26
27use derive_more::Display as DeriveMoreDisplay;
28use serde::{Serialize};
29use std::collections::BTreeMap;
30use crate::parse::{parse_sysctl_value, ParseAsType};
31use crate::error::MacSysInfoError;
32use crate::generated_sysctl_keys::SysctlKey;
33
34/// Memory (RAM) info.
35#[derive(Debug, Serialize, DeriveMoreDisplay)]
36#[display(fmt = "MemoryInfo (\n\
37\x20    total_memory: {},\n\
38)", total_memory)]
39pub struct MemInfo {
40    total_memory: usize,
41}
42
43impl MemInfo {
44    /// Constructor.
45    pub(crate) fn new(sysinfo: &BTreeMap<String, String>) -> Result<Self, MacSysInfoError> {
46        let info = MemInfo {
47            total_memory: parse_sysctl_value(
48                "total_memory",
49                SysctlKey::HwMemsize,
50                sysinfo,
51                ParseAsType::Usize)?
52                .get_usize(),
53        };
54        Ok(info)
55    }
56
57    /// Returns the amount of total memory in bytes.
58    pub fn total_memory(&self) -> usize {
59        self.total_memory
60    }
61
62    /// Returns the amount of total memory in MibiBytes.
63    pub fn total_memory_mb(&self) -> usize {
64        self.total_memory / 1024 / 1024
65    }
66    /// Returns the amount of total memory in GibiBytes.
67    pub fn total_memory_gb(&self) -> usize {
68        self.total_memory / 1024 / 1024 / 1024
69    }
70}