heim-memory 0.0.11

Cross-platform memory 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

use std::fmt;

use heim_common::prelude::*;
use heim_common::units::Information;

use crate::sys;

/// Physical memory statistics.
///
/// Only three metrics are guaranteed to be cross-platform,
/// for other metrics see `MemoryExt` traits in the [os] submodules.
///
/// [os]: ./os/index.html
pub struct Memory(sys::Memory);

wrap!(Memory, sys::Memory);

impl Memory {
    /// The total amount of physical memory.
    pub fn total(&self) -> Information {
        self.as_ref().total()
    }

    /// The amount of memory that can be given instantly to processes
    /// without the system going into swap.
    pub fn available(&self) -> Information {
        self.as_ref().available()
    }

    /// The amount of memory not being used at all (zeroed) that is readily available;
    /// note that this does not reflect the actual memory available.
    pub fn free(&self) -> Information {
        self.as_ref().free()
    }
}

impl fmt::Debug for Memory {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("Memory")
            .field("total", &self.total())
            .field("available", &self.available())
            .field("free", &self.free())
            .finish()
    }
}

/// Returns future which will resolve into [Memory] struct.
///
/// [Memory]: ./struct.Memory.html
pub fn memory() -> impl future::Future<Output = Result<Memory>> {
    sys::memory().map(|res| res.map(Into::into))
}