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

use std::fmt;

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

use crate::sys;

/// Swap memory statistics.
///
/// Only three metrics are guaranteed to be cross-platform,
/// for other metrics see [OS]-specific extensions.
///
/// [OS]: ./os/index.html
pub struct Swap(sys::Swap);

wrap!(Swap, sys::Swap);

impl Swap {
    /// The total amount of swap memory
    pub fn total(&self) -> Information {
        self.0.total()
    }

    /// The used amount of swap memory
    pub fn used(&self) -> Information {
        self.0.used()
    }

    /// The free amount of swap memory
    pub fn free(&self) -> Information {
        self.0.free()
    }
}

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

/// Returns [Swap] memory statistics.
///
/// [Swap]: ./struct.Swap.html
pub async fn swap() -> Result<Swap> {
    sys::swap().await.map(Into::into)
}