documents 0.1.2

An ergonomic, intuitive and beginner-friendly library for dealing with files and folders.
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

/// The mode of opening the file. Describes what you are permitted to do with it.
///
/// *Read*: permission to read the file only.
///
/// *Replace*: permission wipe the file and replace its contents.
///
/// *Append*: permission to add content to the end of the file.
///
/// *ReadReplace*: permission to read the file, and also to wipe the file and replace its contents.
///
/// *ReadAppend*: permission to read the file, and also to add content to the end of the file.
///
/// Read, ReadReplace, ReadAppend are `read`-able.
///
/// Replace, Append, ReadReplace, ReadAppend are `write`-able.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub enum Mode {
    #[default]
    Read,
    Replace,
    Append,
    ReadReplace,
    ReadAppend,
}

impl Mode {
    /// ```
    /// match self {
    ///     Self::Read | Self::ReadReplace | Self::ReadAppend => true,
    ///     _ => false,
    /// }
    /// ```
    pub fn readable(&self) -> bool {
        match self {
            Self::Read | Self::ReadReplace | Self::ReadAppend => true,
            _ => false,
        }
    }

    /// ```
    /// match self {
    ///     Self::Replace | Self::Append | Self::ReadAppend | Self::ReadReplace => true,
    ///     _ => false,
    /// }
    /// ```
    pub fn writable(&self) -> bool {
        match self {
            Self::Replace | Self::Append | Self::ReadAppend | Self::ReadReplace => true,
            _ => false,
        }
    }

    /// ```
    /// match self {
    ///     Self::Append | Self::ReadAppend => true,
    ///     _ => false,
    /// }
    /// ```
    pub fn appendable(&self) -> bool {
        match self {
            Self::Append | Self::ReadAppend => true,
            _ => false,
        }
    }
}