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 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
//! Simple interface to iterate over files or subdirs of a directory //! //! Features: //! //! 1. Ensure that file names are decodable to utf-8 //! (or error/warning is propagated) //! 2. Ignore hidden entries (by default) //! 3. Ignore common text editor and revision control backup files //! 4. Select only files or only directories (and resolve symlinks) //! 5. Simpler but detailed enough error handling //! 6. Recursive directory scanner //! //! For example you can read all subdirectories this way: //! //! ```rust //! use scan_dir::ScanDir; //! //! ScanDir::dirs().read(".", |iter| { //! for (entry, name) in iter { //! println!("File {:?} has full path {:?}", name, entry.path()); //! } //! }).unwrap() //! ``` //! //! Compare it to stdlib way: //! //! ```rust //! use std::fs::read_dir; //! for entry_res in read_dir(".").unwrap() { //! let entry = entry_res.unwrap(); //! let file_name_buf = entry.file_name(); //! let file_name = file_name_buf.to_str().unwrap(); //! if !file_name.starts_with(".") && //! entry.file_type().unwrap().is_dir() //! { //! println!("File {:?} has full path {:?}", //! file_name, entry.path()); //! } //! } //! ``` //! Well, it looks almost fine until you want to turn unwrap's into correct //! error reporting. //! //! Here is a list of non-hidden rust files: //! //! ```rust //! use scan_dir::ScanDir; //! //! let files: Vec<_> = ScanDir::files().read(".", |iter| { //! iter.filter(|&(_, ref name)| name.ends_with(".rs")) //! .map(|(entry, _)| entry.path()) //! .collect() //! }).unwrap(); //! ``` //! //! And when you want to to return an from the closure, you need to //! unify the errors somehow. For example: //! //! ```rust //! use std::io; //! use std::path::PathBuf; //! use std::fs::File; //! use scan_dir::ScanDir; //! //! #[derive(Debug)] //! enum MyError { //! Scan(scan_dir::Error), //! File(io::Error, PathBuf), //! } //! //! let result = ScanDir::files().read(".", |iter| { //! for (entry, name) in iter { //! // ensure file is accessible //! try!(File::open(entry.path()) //! .map_err(|e| MyError::File(e, entry.path()))); //! } //! Ok(()) //! }).map_err(MyError::Scan).and_then(|val| val); //! println!("Error occured {:?}", result.err()); //! ``` //! //! Let's see what's happen here: //! //! 1. The return value of `read()` is `Result<Result<(), io::Error>, MyError>` //! 2. `map_err(MyError::Scan)` turns scan_dir error into our wrapper type //! 3. `and_then(|val| val)` unifies the error, producing `Result<(), MyError>` //! //! Note in the last example you might convert error in the `and_then` clause, //! but we want to know exact file name where error occured so we store it //! in the error inside the lambda. //! //! Recursive scanner works much the same, except (a) iterator yields items //! recursively, in depth-first order. and (b) list of errors returned instead //! of single error. For example: //! //! ```rust //! use scan_dir::ScanDir; //! //! let all_rs_files: Vec<_> = ScanDir::files().walk(".", |iter| { //! iter.filter(|&(_, ref name)| name.ends_with(".rs")) //! .map(|(ref entry, _)| entry.path()) //! .collect() //! }).unwrap(); //! ``` //! #[macro_use] extern crate quick_error; use std::io; use std::path::{PathBuf, Path}; mod iter; mod walk; mod filter; pub use iter::Iter; pub use walk::Walker; quick_error! { /// Error type for scan dir /// /// It always contains the file name of the entry so display of an /// error is always an informative thing #[derive(Debug)] pub enum Error { /// I/O error occured when reading directory /// /// Second parameter contains path to the original directory Io(err: io::Error, path: PathBuf) { cause(err) display("error reading directory {:?}: {}", path, err) description("error reading directory") } /// Can't decode filename /// /// PathBuf contains path to the specific file which has bad filename Decode(path: PathBuf) { display("error decoding file name {:?}", path) description("error decoding file name") } } } /// Settings for directory walker #[derive(Debug, Clone)] pub struct ScanDir { skip_hidden: bool, skip_dirs: bool, skip_files: bool, skip_backup: bool, skip_symlinks: bool, } impl ScanDir { /// Constructs a settings that iterates over all entries /// /// Just a starting point if you need complete control pub fn all() -> ScanDir { ScanDir { skip_hidden: false, skip_dirs: false, skip_files: false, skip_backup: false, skip_symlinks: false, } } /// Constructs a settings which only iterates over files (non-directories). /// /// The hidden and backup files are ignored by default pub fn files() -> ScanDir { ScanDir { skip_hidden: true, skip_dirs: true, skip_files: false, skip_backup: true, skip_symlinks: false, } } /// Constructs a settings which only iterates over directories /// /// The directories which match hidden and backup patterns are excluded pub fn dirs() -> ScanDir { ScanDir { skip_hidden: true, skip_dirs: false, skip_files: true, skip_backup: true, skip_symlinks: false, } } /// Skip hidden files /// /// Hidden files are the ones having the name starting with dot `.` /// (on all platforms) pub fn skip_hidden(&mut self, flag: bool) -> &mut ScanDir { self.skip_hidden = flag; self } /// Skip directory entries pub fn skip_dirs(&mut self, flag: bool) -> &mut ScanDir { self.skip_dirs = flag; self } /// Skip file (non-directory) entries pub fn skip_files(&mut self, flag: bool) -> &mut ScanDir { self.skip_files = flag; self } /// Skip symlinks /// /// By default symlinks are resolve if either skip_dirs or skip_files /// are enabled. So symlink is treated just like entry it points to. /// This method allows to avoid stat call and skip symlinks at all. /// /// If neither `skip_files` nor `skip_dirs` is enabled the symlink is /// never resolved and is returned just like any other directory entry. pub fn skip_symlinks(&mut self, flag: bool) -> &mut ScanDir { self.skip_symlinks = flag; self } /// Skip backup files /// /// This is expected to skip entries that different editors and version /// control systems keep as backup files. We currently do not have precise /// control over this thing, so you may consider turn this off and filter /// entries yourself, if precise control is required. /// /// You may also just filter files by extension instead of using this. /// /// This is mostly useful if hidden files are also skipped. /// /// Currently we ignore the following patterns: /// /// * `*.bak` /// * `*~` -- vim/emacs/other backup files /// * `#*#` -- emacs auto save pub fn skip_backup(&mut self, flag: bool) -> &mut ScanDir { self.skip_backup = flag; self } /// Calls a closure with an iterator over pairs of (entry, name) /// /// Note when it comes to error reporting, here is how errors are /// prioritized: /// /// 1. If there is scan_dir error it has priority over result/error of /// the closure /// 2. The `Io` error have more priority over `Decode` error /// 3. Otherwise first received error is returned if there are multiple /// /// # Example /// /// ```rust /// use scan_dir::ScanDir; /// /// ScanDir::files().read(".", |iter| { /// for (entry, name) in iter { /// println!("File {:?} has full path {:?}", /// name, entry.path()); /// } /// }).unwrap() /// ``` pub fn read<P:AsRef<Path>, R:Sized, F>(&self, path: P, f: F) -> Result<R, Error> where F: FnOnce(Iter) -> R { let mut dir_res = Ok(()); let user_res = f(iter::new(self, &mut dir_res, path.as_ref())); dir_res.and(Ok(user_res)) } /// Calls a closure with recursive walker over the directory /// /// The recursive walker continues to work even if error occured and /// returns a list of the errors in the case at least one error takes /// place. You may put some mutable variable on the stack and /// put the result of the closure there, in case you need to tolerate /// errors. /// /// # Example /// /// This is an example walker which tolerates errors /// /// ```rust /// use scan_dir::ScanDir; /// /// let mut all_files = Vec::new(); /// let walk_result = ScanDir::files().walk(".", |iter| { /// for (entry, name) in iter { /// all_files.push(entry.path()); /// } /// }); /// if let Err(errors) = walk_result { /// for e in errors { /// println!("Error {}. Continue scanning...", e); /// } /// } /// ``` pub fn walk<P:AsRef<Path>, R:Sized, F>(&self, path: P, f: F) -> Result<R, Vec<Error>> where F: FnOnce(Walker) -> R { let mut errors = Vec::new(); let user_res = f(walk::new(self, &mut errors, path.as_ref())); if errors.len() > 0 { Err(errors) } else { Ok(user_res) } } }