sos-vfs 0.3.2

Virtual file system same as tokio::fs.
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
150
151
152
153
154
155
156
157
158
159
160
161

use super::fs::FileFlags;

#[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
use std::io::Result;

#[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
use std::time::SystemTime;

/// Representation of the various permissions on a file.
#[derive(Debug, Default, Copy, Clone, Eq, PartialEq)]
pub struct Permissions {
    read_only: bool,
}

impl Permissions {
    /// Returns true if these permissions describe a
    /// readonly (unwritable) file.
    pub fn readonly(&self) -> bool {
        self.read_only
    }

    /// Modifies the readonly flag for this set of permissions.
    pub fn set_readonly(&mut self, readonly: bool) {
        self.read_only = readonly;
    }
}

/// Access times for in-memory files.
#[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub(crate) struct FileTime {
    /// Time created.
    created: SystemTime,
    /// Time last accessed.
    accessed: SystemTime,
    /// Time last modified.
    modified: SystemTime,
}

#[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
impl Default for FileTime {
    fn default() -> Self {
        Self {
            created: SystemTime::now(),
            accessed: SystemTime::now(),
            modified: SystemTime::now(),
        }
    }
}

/// A structure representing a type of file with accessors
/// for each file type.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub struct FileType(FileFlags);

impl FileType {
    /// Tests whether this file type represents a directory.
    pub fn is_dir(&self) -> bool {
        self.0.contains(FileFlags::DIR)
    }

    /// Tests whether this file type represents a regular file.
    pub fn is_file(&self) -> bool {
        self.0.contains(FileFlags::FILE)
    }

    /// Tests whether this file type represents a symbolic link.
    pub fn is_symlink(&self) -> bool {
        self.0.contains(FileFlags::SYM_LINK)
    }
}

/// Metadata information about a file.
#[derive(Debug, Clone, Eq, PartialEq)]
pub struct Metadata {
    permissions: Permissions,
    flags: FileFlags,
    length: u64,
    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    time: FileTime,
}

impl Metadata {
    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    /// Create new meta data for a file.
    pub(crate) fn new(
        permissions: Permissions,
        flags: FileFlags,
        length: u64,
        time: FileTime,
    ) -> Self {
        Self {
            permissions,
            flags,
            length,
            time,
        }
    }

    #[cfg(all(target_arch = "wasm32", target_os = "unknown"))]
    /// Create new meta data for a file.
    pub(crate) fn new(
        permissions: Permissions,
        flags: FileFlags,
        length: u64,
    ) -> Self {
        Self {
            permissions,
            flags,
            length,
        }
    }

    /// Returns the file type for this metadata.
    pub fn file_type(&self) -> FileType {
        FileType(self.flags)
    }

    /// Tests whether this file type represents a directory.
    pub fn is_dir(&self) -> bool {
        self.file_type().is_dir()
    }

    /// Tests whether this file type represents a regular file.
    pub fn is_file(&self) -> bool {
        self.file_type().is_file()
    }

    /// Tests whether this file type represents a symbolic link.
    pub fn is_symlink(&self) -> bool {
        self.file_type().is_symlink()
    }

    /// Returns the size of the file, in bytes, this metadata is for.
    pub fn len(&self) -> u64 {
        self.length
    }

    /// Returns the permissions of the file this metadata is for.
    pub fn permissions(&self) -> Permissions {
        self.permissions
    }

    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    /// Returns the last access time of this metadata.
    pub fn accessed(&self) -> Result<SystemTime> {
        Ok(self.time.accessed)
    }

    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    /// Returns the creation time listed in this metadata.
    pub fn created(&self) -> Result<SystemTime> {
        Ok(self.time.created)
    }

    #[cfg(not(all(target_arch = "wasm32", target_os = "unknown")))]
    /// Returns the last modification time listed in this metadata.
    pub fn modified(&self) -> Result<SystemTime> {
        Ok(self.time.modified)
    }
}