1 //! Rustdoc's FileSystem abstraction module.
3 //! On Windows this indirects IO into threads to work around performance issues
4 //! with Defender (and other similar virus scanners that do blocking operations).
5 //! On other platforms this is a thin shim to fs.
7 //! Only calls needed to permit this workaround have been abstracted: thus
8 //! fs::read is still done directly via the fs module; if in future rustdoc
9 //! needs to read-after-write from a file, then it would be added to this
14 use std::path::{Path, PathBuf};
15 use std::string::ToString;
16 use std::sync::mpsc::Sender;
18 macro_rules! try_err {
19 ($e:expr, $file:expr) => {
22 Err(e) => return Err(E::new(e, $file)),
27 crate trait PathError {
28 fn new<S, P: AsRef<Path>>(e: S, path: P) -> Self
35 errors: Option<Sender<String>>,
39 crate fn new(errors: Sender<String>) -> DocFS {
40 DocFS { sync_only: false, errors: Some(errors) }
43 crate fn set_sync_only(&mut self, sync_only: bool) {
44 self.sync_only = sync_only;
47 crate fn close(&mut self) {
51 crate fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
52 // For now, dir creation isn't a huge time consideration, do it
53 // synchronously, which avoids needing ordering between write() actions
54 // and directory creation.
55 fs::create_dir_all(path)
61 contents: impl 'static + Send + AsRef<[u8]>,
66 if !self.sync_only && cfg!(windows) {
67 // A possible future enhancement after more detailed profiling would
68 // be to create the file sync so errors are reported eagerly.
69 let sender = self.errors.clone().expect("can't write after closing");
70 rayon::spawn(move || {
71 fs::write(&path, contents).unwrap_or_else(|e| {
72 sender.send(format!("\"{}\": {}", path.display(), e)).unwrap_or_else(|_| {
73 panic!("failed to send error on \"{}\"", path.display())
78 try_err!(fs::write(&path, contents), path);