rusl 0.5.0

Rust linux interface layer
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

use sc::syscall;

use crate::platform::{Fd, AT_FDCWD, AT_REMOVEDIR};
use crate::string::unix_str::UnixStr;

#[derive(Debug, Copy, Clone)]
pub struct UnlinkFlags(i32);

impl UnlinkFlags {
    #[inline]
    #[must_use]
    pub const fn empty() -> Self {
        Self(0)
    }

    #[inline]
    #[must_use]
    pub const fn at_removedir() -> Self {
        Self(AT_REMOVEDIR.value())
    }
}

/// Taking the liberty of using `unlinkat` for both implementations, effectively meaning
/// that `CWD` is the base if the path isn't absolute
/// "unlink, unlinkat - delete a name and possibly the file it refers to"[docs](https://man7.org/linux/man-pages/man2/unlink.2.html)
/// # Errors
/// See above docs
#[inline]
pub fn unlink(path: &UnixStr) -> crate::Result<()> {
    unlink_flags(path, UnlinkFlags::empty())
}

/// Unlink with a path from `CWD` and the provided flags. Flags are either 0 or `AT_REMOVEDIR`.
/// "unlink, unlinkat - delete a name and possibly the file it refers to"[docs](https://man7.org/linux/man-pages/man2/unlink.2.html)
/// # Errors
/// See above docs
#[inline]
pub fn unlink_flags(path: &UnixStr, flags: UnlinkFlags) -> crate::Result<()> {
    do_unlink(AT_FDCWD, path, flags)
}

/// Taking the liberty of using `unlinkat` for both implementations, effectively meaning
/// that `CWD` is the base if the path isn't absolute. Flags are either 0 or `AT_REMOVEDIR`
/// "unlink, unlinkat - delete a name and possibly the file it refers to"[docs](https://man7.org/linux/man-pages/man2/unlink.2.html)
/// # Errors
/// See above docs
#[inline]
pub fn unlink_at(dir_fd: Fd, path: &UnixStr, flags: UnlinkFlags) -> crate::Result<()> {
    do_unlink(dir_fd.0, path, flags)
}

#[inline(always)]
#[expect(clippy::inline_always)]
fn do_unlink(dir_fd: i32, path: &UnixStr, flags: UnlinkFlags) -> crate::Result<()> {
    let res = unsafe { syscall!(UNLINKAT, dir_fd, path.as_ptr(), flags.0) };
    bail_on_below_zero!(res, "`UNLINKAT` syscall failed");
    Ok(())
}

/// Taking the liberty of using `unlinkat` for both implementations, effectively meaning
/// that `CWD` is the base if the path isn't absolute. Flags are either 0 or `AT_REMOVEDIR`
/// "unlink, unlinkat - delete a name and possibly the file it refers to"[docs](https://man7.org/linux/man-pages/man2/unlink.2.html)
/// # Errors
/// See above docs
#[inline]
pub fn rmdir(dir_fd: Fd) -> crate::Result<()> {
    let res = unsafe { syscall!(UNLINKAT, dir_fd.0, 0, AT_REMOVEDIR.0) };
    bail_on_below_zero!(res, "`UNLINKAT` syscall failed");
    Ok(())
}