bottom 0.12.3

A customizable cross-platform graphical process/system monitor for the terminal. Supports Linux, macOS, and Windows.
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

use std::{
    ffi::{CStr, CString},
    os::unix::prelude::OsStrExt,
    path::{Path, PathBuf},
    str::FromStr,
};

use anyhow::bail;

use super::bindings;
use crate::collection::disks::unix::{FileSystem, Usage};

pub(crate) struct Partition {
    device: String,
    mount_point: PathBuf,
    fs_type: FileSystem,
}

impl Partition {
    /// Returns the mount point for this partition.
    #[inline]
    pub fn mount_point(&self) -> &Path {
        self.mount_point.as_path()
    }

    /// Returns the [`FileSystem`] of this partition.
    #[inline]
    pub fn fs_type(&self) -> &FileSystem {
        &self.fs_type
    }

    /// Returns the usage stats for this partition.
    pub fn usage(&self) -> anyhow::Result<Usage> {
        let path = CString::new(self.mount_point().as_os_str().as_bytes())?;
        let mut vfs = std::mem::MaybeUninit::<libc::statvfs>::uninit();

        // SAFETY: System API call. Arguments should be correct.
        let result = unsafe { libc::statvfs(path.as_ptr(), vfs.as_mut_ptr()) };

        if result == 0 {
            // SAFETY: We check that it succeeded (result is 0), which means vfs should be
            // populated.
            Ok(Usage::new(unsafe { vfs.assume_init() }))
        } else {
            bail!("statvfs failed to get the disk usage for disk {path:?}")
        }
    }

    /// Returns the device name.
    #[inline]
    pub fn get_device_name(&self) -> String {
        self.device.clone()
    }
}

fn partitions_iter() -> anyhow::Result<impl Iterator<Item = Partition>> {
    let mounts = bindings::mounts()?;

    unsafe fn ptr_to_cow<'a>(ptr: *const i8) -> std::borrow::Cow<'a, str> {
        unsafe { CStr::from_ptr(ptr).to_string_lossy() }
    }

    Ok(mounts.into_iter().map(|stat| {
        // SAFETY: Should be a non-null pointer.
        let device = unsafe { ptr_to_cow(stat.f_mntfromname.as_ptr()).to_string() };

        let fs_type = {
            // SAFETY: Should be a non-null pointer.
            let fs_type_str = unsafe { ptr_to_cow(stat.f_fstypename.as_ptr()) };
            FileSystem::from_str(&fs_type_str).unwrap_or(FileSystem::Other(fs_type_str.to_string()))
        };

        let mount_point = {
            // SAFETY: Should be a non-null pointer.
            let path_str = unsafe { ptr_to_cow(stat.f_mntonname.as_ptr()).to_string() };
            PathBuf::from(path_str)
        };

        Partition {
            device,
            mount_point,
            fs_type,
        }
    }))
}

#[expect(dead_code)]
/// Returns a [`Vec`] containing all partitions.
pub(crate) fn partitions() -> anyhow::Result<Vec<Partition>> {
    partitions_iter().map(|iter| iter.collect())
}

/// Returns a [`Vec`] containing all *physical* partitions. This is defined by
/// [`FileSystem::is_physical()`].
pub(crate) fn physical_partitions() -> anyhow::Result<Vec<Partition>> {
    partitions_iter().map(|iter| {
        iter.filter(|partition| partition.fs_type().is_physical())
            .collect()
    })
}