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
//! # directory //! //! Directory utility functions. //! #[cfg(test)] #[path = "./directory_test.rs"] mod directory_test; use crate::error::{ErrorInfo, FsIOError}; use crate::path::as_path::AsPath; use crate::path::get_parent_directory; use std::fs::{create_dir_all, remove_dir_all}; /// Creates the directory (and if needed the parent directories) for the provided path. /// /// # Arguments /// /// * `path` - The directory path /// /// # Example /// /// ``` /// extern crate fsio; /// /// use crate::fsio::directory; /// use std::path::Path; /// /// fn main() { /// let result = directory::create("./target/__test/directory_test/dir1/dir2"); /// assert!(result.is_ok()); /// /// let path = Path::new("./target/__test/directory_test/dir1/dir2"); /// assert!(path.exists()); /// } /// ``` pub fn create<T: AsPath + ?Sized>(path: &T) -> Result<(), FsIOError> { let directory_path = path.as_path(); if directory_path.is_dir() && directory_path.exists() { return Ok(()); } match create_dir_all(&directory_path) { Ok(_) => Ok(()), Err(error) => Err(FsIOError { info: ErrorInfo::IOError( format!("Unable to create directory: {:?}.", &directory_path).to_string(), Some(error), ), }), } } /// Creates the parent directory (and if needed the parent directories) for the provided path. /// In case no parent directory path component exists, this function will return ok result. /// /// # Arguments /// /// * `path` - The child path /// /// # Example /// /// ``` /// extern crate fsio; /// /// use crate::fsio::directory; /// use std::path::Path; /// /// fn main() { /// let result = directory::create_parent("./target/__test/directory_test/dir1/files/file.txt"); /// assert!(result.is_ok()); /// /// let path = Path::new("./target/__test/directory_test/dir1/files"); /// assert!(path.exists()); /// } /// ``` pub fn create_parent<T: AsPath + ?Sized>(path: &T) -> Result<(), FsIOError> { match get_parent_directory(path) { Some(directory) => create(&directory), None => Ok(()), } } /// Deletes the directory and any child file/directory. /// /// # Arguments /// /// * `path` - The directory path /// /// # Example /// /// ``` /// extern crate fsio; /// /// use crate::fsio::{directory, file}; /// use std::path::Path; /// /// fn main() { /// file::ensure_exists("./target/__test/directory_test/delete_directory/dir1/dir2/file.txt").unwrap(); /// let path = Path::new("./target/__test/directory_test/delete_directory"); /// assert!(path.exists()); /// /// let result = directory::delete("./target/__test/directory_test/delete_directory"); /// assert!(result.is_ok()); /// /// assert!(!path.exists()); /// } /// ``` pub fn delete<T: AsPath + ?Sized>(path: &T) -> Result<(), FsIOError> { let directory_path = path.as_path(); if directory_path.exists() { if directory_path.is_dir() { match remove_dir_all(directory_path) { Ok(_) => Ok(()), Err(error) => Err(FsIOError { info: ErrorInfo::IOError( format!("Unable to delete directory: {:?}", &directory_path).to_string(), Some(error), ), }), } } else { Err(FsIOError { info: ErrorInfo::NotFile( format!("Path: {:?} is not a directory.", &directory_path).to_string(), ), }) } } else { Ok(()) } }