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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

use sc::syscall;

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

/// Renames `old_path` to `new_path` overwriting any content at `new_path`
/// # Errors
/// See the [linux docs for details](https://man7.org/linux/man-pages/man2/rename.2.html#ERRORS)
#[inline(always)]
#[expect(clippy::inline_always)]
pub fn rename(old_path: &UnixStr, new_path: &UnixStr) -> crate::Result<()> {
    do_rename_at(AT_FDCWD, old_path, AT_FDCWD, new_path, RenameFlags::empty())
}

/// Renames `old_path` to `new_path` with `flags`.
/// # Errors
/// See the [linux docs for details](https://man7.org/linux/man-pages/man2/rename.2.html#ERRORS)
#[inline(always)]
#[expect(clippy::inline_always)]
pub fn rename_flags(
    old_path: &UnixStr,
    new_path: &UnixStr,
    flags: RenameFlags,
) -> crate::Result<()> {
    do_rename_at(AT_FDCWD, old_path, AT_FDCWD, new_path, flags)
}

/// Renames `old_path` to `new_path` with `flags`.
/// # Errors
/// See the [linux docs for details](https://man7.org/linux/man-pages/man2/rename.2.html#ERRORS)
#[inline(always)]
#[expect(clippy::inline_always)]
pub fn rename_at(
    old_dir_fd: Fd,
    old_path: &UnixStr,
    new_dir_fd: Fd,
    new_path: &UnixStr,
) -> crate::Result<()> {
    do_rename_at(
        old_dir_fd.value(),
        old_path,
        new_dir_fd.value(),
        new_path,
        RenameFlags::empty(),
    )
}

/// Renames `old_path` to `new_path` with `flags`.
/// # Errors
/// See the [linux docs for details](https://man7.org/linux/man-pages/man2/rename.2.html#ERRORS)
#[inline(always)]
#[expect(clippy::inline_always)]
pub fn rename_at2(
    old_dir_fd: Fd,
    old_path: &UnixStr,
    new_dir_fd: Fd,
    new_path: &UnixStr,
    flags: RenameFlags,
) -> crate::Result<()> {
    do_rename_at(
        old_dir_fd.value(),
        old_path,
        new_dir_fd.value(),
        new_path,
        flags,
    )
}

fn do_rename_at(
    old_dir_fd: i32,
    old_path: &UnixStr,
    new_dir_fd: i32,
    new_path: &UnixStr,
    flags: RenameFlags,
) -> crate::Result<()> {
    let res = unsafe {
        syscall!(
            RENAMEAT2,
            old_dir_fd,
            old_path.as_ptr(),
            new_dir_fd,
            new_path.as_ptr(),
            flags.bits()
        )
    };
    bail_on_below_zero!(res, "`RENAMEAT2` syscall failed`");
    Ok(())
}