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

use std::ffi::OsStr;
use std::fmt;
use std::path::Path;

use heim_common::prelude::*;

use crate::{sys, usage, FileSystem, Usage};

/// Mounted disk partition.
///
/// ## Compatibility
///
/// See [os]-specific extension traits also.
///
/// [os]: ./os/index.html
pub struct Partition(sys::Partition);

wrap!(Partition, sys::Partition);

impl Partition {
    /// Returns partition device name if available.
    pub fn device(&self) -> Option<&OsStr> {
        self.as_ref().device()
    }

    /// Returns partition mount point path.
    pub fn mount_point(&self) -> &Path {
        self.as_ref().mount_point()
    }

    /// Returns partition file system.
    pub fn file_system(&self) -> &FileSystem {
        self.as_ref().file_system()
    }

    /// Returns disk [Usage] statistics about this particular partition.
    ///
    /// Internally it is the same as calling [usage] with [`mount_point`] call as an argument,
    /// but more convenient to use.
    ///
    /// [Usage]: ./struct.Usage.html
    /// [usage]: ./fn.usage.html
    pub async fn usage(&self) -> Result<Usage> {
        usage(self.mount_point()).await
    }
}

impl fmt::Debug for Partition {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("Partition")
            .field("device", &self.device())
            .field("mount_point", &self.mount_point())
            .field("file_system", &self.file_system())
            .finish()
    }
}

/// Returns a stream over mounted disk [Partitions].
///
/// This includes all virtual partitions, such as `tmpfs`.
/// See [partitions_physical] for physical partitions stream.
///
/// [Partitions]: struct.Partition.html
pub async fn partitions() -> Result<impl Stream<Item = Result<Partition>>> {
    let inner = sys::partitions().await?;

    Ok(inner.map_ok(Into::into))
}

/// Returns a stream over physical only mounted disk [Partitions].
///
/// [Partitions]: struct.Partition.html
pub async fn partitions_physical() -> Result<impl Stream<Item = Result<Partition>>> {
    let inner = sys::partitions_physical().await?;

    Ok(inner.map_ok(Into::into))
}