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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
#![doc(html_root_url = "https://docs.rs/fs-err/2.6.0")]
#![deny(missing_debug_implementations, missing_docs)]
mod dir;
mod errors;
mod file;
mod open_options;
pub mod os;
mod path;
use std::fs;
use std::io::{self, Read, Write};
use std::path::{Path, PathBuf};
use errors::{Error, ErrorKind, SourceDestError, SourceDestErrorKind};
pub use dir::*;
pub use file::*;
pub use open_options::OpenOptions;
pub use path::PathExt;
pub fn read<P: AsRef<Path>>(path: P) -> io::Result<Vec<u8>> {
let path = path.as_ref();
let mut file = file::open(path.as_ref()).map_err(|err_gen| err_gen(path.to_path_buf()))?;
let mut bytes = Vec::with_capacity(initial_buffer_size(&file));
file.read_to_end(&mut bytes)
.map_err(|err| Error::new(err, ErrorKind::Read, path))?;
Ok(bytes)
}
pub fn read_to_string<P: AsRef<Path>>(path: P) -> io::Result<String> {
let path = path.as_ref();
let mut file = file::open(path.as_ref()).map_err(|err_gen| err_gen(path.to_path_buf()))?;
let mut string = String::with_capacity(initial_buffer_size(&file));
file.read_to_string(&mut string)
.map_err(|err| Error::new(err, ErrorKind::Read, path))?;
Ok(string)
}
pub fn write<P: AsRef<Path>, C: AsRef<[u8]>>(path: P, contents: C) -> io::Result<()> {
let path = path.as_ref();
file::create(path)
.map_err(|err_gen| err_gen(path.to_path_buf()))?
.write_all(contents.as_ref())
.map_err(|err| Error::new(err, ErrorKind::Write, path))
}
pub fn copy<P, Q>(from: P, to: Q) -> io::Result<u64>
where
P: AsRef<Path>,
Q: AsRef<Path>,
{
let from = from.as_ref();
let to = to.as_ref();
fs::copy(from, to)
.map_err(|source| SourceDestError::new(source, SourceDestErrorKind::Copy, from, to))
}
pub fn create_dir<P>(path: P) -> io::Result<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
fs::create_dir(path).map_err(|source| Error::new(source, ErrorKind::CreateDir, path))
}
pub fn create_dir_all<P>(path: P) -> io::Result<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
fs::create_dir_all(path).map_err(|source| Error::new(source, ErrorKind::CreateDir, path))
}
pub fn remove_dir<P>(path: P) -> io::Result<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
fs::remove_dir(path).map_err(|source| Error::new(source, ErrorKind::RemoveDir, path))
}
pub fn remove_dir_all<P>(path: P) -> io::Result<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
fs::remove_dir_all(path).map_err(|source| Error::new(source, ErrorKind::RemoveDir, path))
}
pub fn remove_file<P>(path: P) -> io::Result<()>
where
P: AsRef<Path>,
{
let path = path.as_ref();
fs::remove_file(path).map_err(|source| Error::new(source, ErrorKind::RemoveFile, path))
}
pub fn metadata<P: AsRef<Path>>(path: P) -> io::Result<fs::Metadata> {
let path = path.as_ref();
fs::metadata(path).map_err(|source| Error::new(source, ErrorKind::Metadata, path))
}
pub fn canonicalize<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
let path = path.as_ref();
fs::canonicalize(path).map_err(|source| Error::new(source, ErrorKind::Canonicalize, path))
}
pub fn hard_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
let src = src.as_ref();
let dst = dst.as_ref();
fs::hard_link(src, dst)
.map_err(|source| SourceDestError::new(source, SourceDestErrorKind::HardLink, src, dst))
}
pub fn read_link<P: AsRef<Path>>(path: P) -> io::Result<PathBuf> {
let path = path.as_ref();
fs::read_link(path).map_err(|source| Error::new(source, ErrorKind::ReadLink, path))
}
pub fn rename<P: AsRef<Path>, Q: AsRef<Path>>(from: P, to: Q) -> io::Result<()> {
let from = from.as_ref();
let to = to.as_ref();
fs::rename(from, to)
.map_err(|source| SourceDestError::new(source, SourceDestErrorKind::Rename, from, to))
}
#[deprecated = "replaced with std::os::unix::fs::symlink and \
std::os::windows::fs::{symlink_file, symlink_dir}"]
pub fn soft_link<P: AsRef<Path>, Q: AsRef<Path>>(src: P, dst: Q) -> io::Result<()> {
let src = src.as_ref();
let dst = dst.as_ref();
#[allow(deprecated)]
fs::soft_link(src, dst)
.map_err(|source| SourceDestError::new(source, SourceDestErrorKind::SoftLink, src, dst))
}
pub fn symlink_metadata<P: AsRef<Path>>(path: P) -> io::Result<fs::Metadata> {
let path = path.as_ref();
fs::symlink_metadata(path)
.map_err(|source| Error::new(source, ErrorKind::SymlinkMetadata, path))
}
pub fn set_permissions<P: AsRef<Path>>(path: P, perm: fs::Permissions) -> io::Result<()> {
let path = path.as_ref();
fs::set_permissions(path, perm)
.map_err(|source| Error::new(source, ErrorKind::SetPermissions, path))
}
fn initial_buffer_size(file: &std::fs::File) -> usize {
file.metadata().map(|m| m.len() as usize + 1).unwrap_or(0)
}
pub(crate) use private::Sealed;
mod private {
pub trait Sealed {}
impl Sealed for crate::File {}
impl Sealed for std::path::Path {}
impl Sealed for crate::OpenOptions {}
}