nix 0.31.2

Rust friendly bindings to *nix APIs
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
101
102
103
104
105
106
107
108
109
110
111

use crate::{Errno, NixPath, Result};
use libc::c_int;

libc_bitflags!(
    /// Used with [`mount()`] and [`unmount()`].
    pub struct MntFlags: c_int {
        /// Do not interpret special files on the filesystem.
        MNT_NODEV;
        /// Enable data protection on the filesystem if the filesystem is configured for it.
        MNT_CPROTECT;
        /// file system is quarantined
        MNT_QUARANTINE;
        /// filesystem is stored locally
        MNT_LOCAL;
        /// quotas are enabled on filesystem
        MNT_QUOTA;
        /// identifies the root filesystem
        MNT_ROOTFS;
        /// file system is not appropriate path to user data
        MNT_DONTBROWSE;
        /// VFS will ignore ownership information on filesystem objects
        MNT_IGNORE_OWNERSHIP;
        /// filesystem was mounted by automounter
        MNT_AUTOMOUNTED;
        /// filesystem is journaled
        MNT_JOURNALED;
        /// Don't allow user extended attributes
        MNT_NOUSERXATTR;
        /// filesystem should defer writes
        MNT_DEFWRITE;
        /// don't block unmount if not responding
        MNT_NOBLOCK;
        /// file system is exported
        MNT_EXPORTED;
        /// file system written asynchronously
        MNT_ASYNC;
        /// Force a read-write mount even if the file system appears to be
        /// unclean.
        MNT_FORCE;
        /// MAC support for objects.
        MNT_MULTILABEL;
        /// Do not update access times.
        MNT_NOATIME;
        /// Disallow program execution.
        MNT_NOEXEC;
        /// Do not honor setuid or setgid bits on files when executing them.
        MNT_NOSUID;
        /// Mount read-only.
        MNT_RDONLY;
        /// Causes the vfs subsystem to update its data structures pertaining to
        /// the specified already mounted file system.
        MNT_RELOAD;
        /// Create a snapshot of the file system.
        MNT_SNAPSHOT;
        /// All I/O to the file system should be done synchronously.
        MNT_SYNCHRONOUS;
        /// Union with underlying fs.
        MNT_UNION;
        /// Indicates that the mount command is being applied to an already
        /// mounted file system.
        MNT_UPDATE;
    }
);

/// Mount a file system.
///
/// # Arguments
/// - `source`  -   Specifies the file system.  e.g. `/dev/sd0`.
/// - `target` -    Specifies the destination.  e.g. `/mnt`.
/// - `flags` -     Optional flags controlling the mount.
/// - `data` -      Optional file system specific data.
///
/// # see also
/// [`mount`](https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man2/mount.2.html)
pub fn mount<
    P1: ?Sized + NixPath,
    P2: ?Sized + NixPath,
    P3: ?Sized + NixPath,
>(
    source: &P1,
    target: &P2,
    flags: MntFlags,
    data: Option<&P3>,
) -> Result<()> {
    let res = source.with_nix_path(|s| {
        target.with_nix_path(|t| {
            crate::with_opt_nix_path(data, |d| unsafe {
                libc::mount(
                    s.as_ptr(),
                    t.as_ptr(),
                    flags.bits(),
                    d.cast_mut().cast(),
                )
            })
        })
    })???;

    Errno::result(res).map(drop)
}

/// Umount the file system mounted at `target`.
pub fn unmount<P>(target: &P, flags: MntFlags) -> Result<()>
where
    P: ?Sized + NixPath,
{
    let res = target.with_nix_path(|cstr| unsafe {
        libc::unmount(cstr.as_ptr(), flags.bits())
    })?;

    Errno::result(res).map(drop)
}