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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

#[macro_export]
macro_rules! bail_on_below_zero {
    ($res: expr, $out_line: expr) => {
        if $crate::platform::is_syscall_error($res) {
            // Flip the errno
            return Err($crate::Error::with_code($out_line, 0 - $res as i32));
        }
    };
}

// Macro for creating non-strict transparent bitflags, a newtype around some value.
// It's strict in the way that it's hard to make values that are not correct without using unsafe.
#[macro_export]
macro_rules! transparent_bitflags {
    (
        $(#[$outer:meta])*
        $vis:vis struct $BitFlags:ident: $T:ty {
            const DEFAULT = $const_default:expr;
            $(
                $(#[$inner:ident $($args:tt)*])*
                const $Flag:ident = $value:expr;
            )*
        }
    ) => {
        $(#[$outer])*
        #[repr(transparent)]
        #[derive(Debug, Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)]
        $vis struct $BitFlags(pub(crate) $T);

        impl $BitFlags {

            const DEFAULT: Self = Self($const_default);
            $(
                $(#[$inner $($args)*])*
                $vis const $Flag: Self = Self($value);
            )*

            #[must_use]
            #[inline(always)]
            #[allow(dead_code)]
            $vis const fn bits(&self) -> $T {
                self.0
            }

            #[inline]
            #[must_use]
            #[allow(dead_code)]
            $vis const fn empty() -> Self {
                Self::DEFAULT
            }

            #[inline]
            #[must_use]
            #[allow(dead_code)]
            $vis fn contains(&self, other: Self) -> bool {
                self.0 & other.0 != Self::DEFAULT.0
            }
        }

        impl Default for $BitFlags {
            #[inline]
            fn default() -> Self {
                Self::empty()
            }
        }

        impl core::ops::BitOr for $BitFlags {
            type Output = Self;

            #[inline]
            fn bitor(self, rhs: Self) -> Self::Output {
                Self(self.0 | rhs.0)
            }
        }

        impl core::ops::BitAnd for $BitFlags {
            type Output = Self;

            #[inline]
            fn bitand(self, rhs: Self) -> Self::Output {
                Self(self.0 & rhs.0)
            }
        }

        impl core::ops::BitAndAssign for $BitFlags {
            #[inline]
            fn bitand_assign(&mut self, rhs: Self) {
                self.0 &= rhs.0;
            }
        }

        impl core::ops::BitOrAssign for $BitFlags {
            #[inline]
            fn bitor_assign(&mut self, rhs: Self) {
                self.0 |= rhs.0;
            }
        }
    };
}

#[cfg(test)]
#[macro_export]
macro_rules! errno_or_throw {
    ($res: expr) => {
        match $res {
            Ok(_) => panic!("Expected error, found success!"),
            Err(e) => e.code.unwrap(),
        }
    };
}

#[cfg(test)]
#[macro_export]
macro_rules! expect_errno {
    ($errno: expr, $res: expr) => {
        assert_eq!($errno, $crate::errno_or_throw!($res));
    };
}

/// comp-time-checked null-terminated string literal, adds null terminator.
/// Will fail to compile if invalid.
#[macro_export]
macro_rules! unix_lit {
    ($lit: literal) => {{
        const __LIT_VAL: &$crate::string::unix_str::UnixStr =
            $crate::string::unix_str::UnixStr::from_str_checked(concat!($lit, "\0"));
        __LIT_VAL
    }};
}

#[cfg(test)]
mod tests {
    use crate::string::unix_str::UnixStr;

    #[test]
    fn lit_macro() {
        let my_var = unix_lit!("hello");
        assert_eq!(UnixStr::try_from_str("hello\0").unwrap(), my_var);
    }
}