efs 0.5.0

An OS and architecture independent implementation of some Unix filesystems in Rust.
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
141
142
143

//! Interface for UNIX permissions.
//!
//! See [this Wikipedia page](https://en.wikipedia.org/wiki/File-system_permissions#Notation_of_traditional_Unix_permissions) and [this POSIX definition](https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap04.html#tag_04_07).

use core::fmt::Display;

use bitflags::bitflags;

use crate::fs::types::Mode;

/// Represents the three permission classes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Class {
    /// Owner of the file.
    Owner,

    /// Group members of the file.
    Group,

    /// Other users.
    Other,
}

/// Represents a triad of permissions.
#[derive(Debug, Clone, Copy)]
pub struct Triad {
    /// Read permission.
    pub read: bool,

    /// Write permission.
    pub write: bool,

    /// Execution permission.
    pub execution: bool,
}

bitflags! {
    /// Permissions bits.
    ///
    /// The permission indicator occupies the bottom 12 bits.
    #[derive(Debug, Clone, Copy, PartialEq, Eq)]
    pub struct Permissions: u16 {
        /// Other - execute permission
        const OTHER_EXECUTION   =   0o000_001;

        /// Other - write permission
        const OTHER_WRITE       =   0o000_002;

        /// Other - read permission
        const OTHER_READ        =   0o000_004;

        /// Group - execute permission
        const GROUP_EXECUTION   =   0o000_010;

        /// Group - write permission
        const GROUP_WRITE       =   0o000_020;

        /// Group - read permission
        const GROUP_READ        =   0o000_040;

        /// User - execute permission
        const USER_EXECUTION    =   0o000_100;

        /// User - write permission
        const USER_WRITE        =   0o000_200;

        /// User - read permission
        const USER_READ         =   0o000_400;

        /// Sticky bit
        const STICKY            =   0o001_000;

        /// Set group ID
        const SET_GROUP_ID      =   0o002_000;

        /// Set user ID
        const SET_USER_ID       =   0o004_000;
    }
}

impl Display for Permissions {
    fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        write!(
            fmt,
            "{}{}{}{}{}{}{}{}{}",
            if self.contains(Self::USER_READ) { "r" } else { "-" },
            if self.contains(Self::USER_WRITE) { "w" } else { "-" },
            if self.contains(Self::USER_WRITE) && self.contains(Self::SET_USER_ID) {
                "s"
            } else if self.contains(Self::SET_USER_ID) {
                "S"
            } else if self.contains(Self::USER_EXECUTION) {
                "x"
            } else {
                "-"
            },
            if self.contains(Self::GROUP_READ) { "r" } else { "-" },
            if self.contains(Self::GROUP_WRITE) { "w" } else { "-" },
            if self.contains(Self::GROUP_WRITE) && self.contains(Self::SET_GROUP_ID) {
                "s"
            } else if self.contains(Self::SET_GROUP_ID) {
                "S"
            } else if self.contains(Self::GROUP_EXECUTION) {
                "x"
            } else {
                "-"
            },
            if self.contains(Self::OTHER_READ) { "r" } else { "-" },
            if self.contains(Self::OTHER_WRITE) { "w" } else { "-" },
            if self.contains(Self::OTHER_WRITE) { "x" } else { "-" }
        )
    }
}

impl From<Mode> for Permissions {
    fn from(value: Mode) -> Self {
        Self::from_bits_truncate(value.0)
    }
}

impl From<Permissions> for Mode {
    fn from(value: Permissions) -> Self {
        Self(value.bits())
    }
}

impl Permissions {
    /// Returns the permission [`Triad`] for the given [`Class`].
    #[must_use]
    pub const fn triad_for(&self, class: Class) -> Triad {
        let (read_class, write_class, execution_class) = match class {
            Class::Owner => (Self::USER_READ, Self::USER_WRITE, Self::USER_EXECUTION),
            Class::Group => (Self::GROUP_READ, Self::GROUP_WRITE, Self::GROUP_EXECUTION),
            Class::Other => (Self::OTHER_READ, Self::OTHER_WRITE, Self::OTHER_EXECUTION),
        };

        Triad {
            read: self.contains(read_class),
            write: self.contains(write_class),
            execution: self.contains(execution_class),
        }
    }
}