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
17 use std::sync::mpsc::{channel, Receiver, Sender};
20 macro_rules! try_err {
21 ($e:expr, $file:expr) => {{
24 Err(e) => return Err(E::new(e, $file)),
30 fn new<P: AsRef<Path>>(e: io::Error, path: P) -> Self;
33 pub struct ErrorStorage {
34 sender: Option<Sender<Option<String>>>,
35 receiver: Receiver<Option<String>>,
39 pub fn new() -> ErrorStorage {
40 let (sender, receiver) = channel();
41 ErrorStorage { sender: Some(sender), receiver }
44 /// Prints all stored errors. Returns the number of printed errors.
45 pub fn write_errors(&mut self, diag: &errors::Handler) -> usize {
47 // In order to drop the sender part of the channel.
50 for msg in self.receiver.iter() {
51 if let Some(ref error) = msg {
52 diag.struct_err(&error).emit();
62 errors: Arc<ErrorStorage>,
66 pub fn new(errors: &Arc<ErrorStorage>) -> DocFS {
67 DocFS { sync_only: false, errors: Arc::clone(errors) }
70 pub fn set_sync_only(&mut self, sync_only: bool) {
71 self.sync_only = sync_only;
74 pub fn create_dir_all<P: AsRef<Path>>(&self, path: P) -> io::Result<()> {
75 // For now, dir creation isn't a huge time consideration, do it
76 // synchronously, which avoids needing ordering between write() actions
77 // and directory creation.
78 fs::create_dir_all(path)
81 pub fn write<P, C, E>(&self, path: P, contents: C) -> Result<(), E>
87 if !self.sync_only && cfg!(windows) {
88 // A possible future enhancement after more detailed profiling would
89 // be to create the file sync so errors are reported eagerly.
90 let contents = contents.as_ref().to_vec();
91 let path = path.as_ref().to_path_buf();
92 let sender = self.errors.sender.clone().unwrap();
93 rayon::spawn(move || match fs::write(&path, &contents) {
97 .expect(&format!("failed to send error on \"{}\"", path.display()));
101 .send(Some(format!("\"{}\": {}", path.display(), e)))
102 .expect(&format!("failed to send non-error on \"{}\"", path.display()));
107 Ok(try_err!(fs::write(&path, contents), path))