diskit 0.1.5

Utilities for intercepting disk requests.
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
144
145
146
147
148
149

//! Transparent replica of [`Metadata`](std::fs::Metadata)
//!
//! For more information see the [struct level documentation](Metadata).

use std::fs;

/// Type of a file on disk
///
/// There are currently there forms of files supported by this
/// library: [`File`](Self::File), [`Dir`](Self::Dir) and
/// [`Symlink`](Self::Symlink) (please notice that
/// [`VirtualDiskit`](crate::VirtualDiskit) does not support
/// symlinks).
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum FileType
{
    /// A normal file
    File,
    /// A directory
    Dir,
    /// A symbolic link
    Symlink,
}

/// Transparent replica of [`Metadata`](std::fs::Metadata)
///
/// This is a [replica](crate#making-your-own-diskit) of
/// [`Metadata`](std::fs::Metadata).  It stores just the [`FileType`]
/// and the length of the file.
// See lib.rs for justification.
#[allow(missing_docs)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub struct Metadata
{
    pub file_type: FileType,
    pub len: u64,
}

impl FileType
{
    /// Returns whether the file is a directory
    ///
    /// This function returns whether the file is a directory.
    #[must_use]
    pub fn is_dir(&self) -> bool
    {
        *self == Self::Dir
    }

    /// Returns whether the file is a normal file
    ///
    /// This function returns whether the file is a normal file.
    #[must_use]
    pub fn is_file(&self) -> bool
    {
        *self == Self::File
    }

    /// Returns whether the file is a symlink
    ///
    /// This function returns whether the file is a symlink.
    #[must_use]
    pub fn is_symlink(&self) -> bool
    {
        *self == Self::Symlink
    }
}

impl Metadata
{
    /// Returns the file type
    ///
    /// This function returns the file type.
    #[must_use]
    pub const fn file_type(&self) -> FileType
    {
        self.file_type
    }

    /// Returns whether the file is a directory
    ///
    /// This function returns whether the file is a directory.
    #[must_use]
    pub fn is_dir(&self) -> bool
    {
        self.file_type == FileType::Dir
    }

    /// Returns whether the file is a normal file
    ///
    /// This function returns whether the file is a normal file.
    #[must_use]
    pub fn is_file(&self) -> bool
    {
        self.file_type == FileType::File
    }

    /// Returns whether the file is a symlink
    ///
    /// This function returns whether the file is a symlink.
    #[must_use]
    pub fn is_symlink(&self) -> bool
    {
        self.file_type == FileType::Symlink
    }

    /// Returns the length of the file
    ///
    /// This function returns the length of the file (in bytes).  The
    /// length of a directory is always `0`, not `4096` or the number of
    /// entries.
    #[must_use]
    pub const fn len(&self) -> u64
    {
        self.len
    }

    /// Returns whether the file is empty
    ///
    /// This function returns whether the length of this file as
    /// returned by [`Metadata::len`] is zero or not.
    #[must_use]
    pub const fn is_empty(&self) -> bool
    {
        self.len == 0
    }
}

impl From<fs::Metadata> for Metadata
{
    fn from(metadata: fs::Metadata) -> Self
    {
        Self {
            file_type: if metadata.is_dir()
            {
                FileType::Dir
            }
            else if metadata.is_file()
            {
                FileType::File
            }
            else
            {
                FileType::Symlink
            },
            len: metadata.len(),
        }
    }
}