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
//! Fast, easy deletion of files and folders with async and cross-platform support. //! ## Overview //! //! This crate allows for fast and easy deletion of files and folders. It has `async` and cross-platform support. //! //! Many of the functions in this crate directly call `std::fs` and `tokio::fs`. //! //! This crate aims to be: //! //! - Fast //! - Easy To Use //! - Powerful //! //! ## Examples //! //! ### Non-Async Implementation //! //! ```rust //! use delete::{delete_file}; //! //! fn main() { //! // Delete file.txt //! delete_file("file.txt").unwrap(); //! } //! ``` //! //! ```rust //! use delete::{delete_folder}; //! //! fn main() { //! // Delete tests folder //! delete_folder("tests").unwrap(); //! } //! ``` //! //! ### Async Implementation //! //! ```rust //! use delete::{delete_file_async}; //! //! #[tokio::main] //! async fn main() { //! // Delete file.txt asynchronously //! delete_file_async("file.txt").await.unwrap(); //! } //! ``` //! //! ```rust //! use delete::{delete_folder_async}; //! //! #[tokio::main] //! async fn main() { //! // Delete tests folder asynchronously //! delete_folder_async("tests").await.unwrap(); //! } //! ``` //! //! ## Rapid Implementations //! //! ```rust //! use delete::{rapid_delete_dir_all}; //! //! #[tokio::main] //! async fn main() { //! // 2-3x faster than std::fs::remove_dir_all //! // removes all files and folders in subfolders parallely using tokio workers //! rapid_delete_dir_all("node_modules", None, None).await; //! } //! ``` //! //! ### Credits //! //! [tokio](https://crates.io/crates/tokio) use futures::stream::{FuturesUnordered, StreamExt}; fn walkdir(path: &str) -> (Vec<String>, Vec<String>) { let mut files_vec: Vec<String> = vec![]; let mut folders_vec: Vec<String> = vec![]; for entry in jwalk::WalkDir::new(path) { let entry = entry.unwrap(); if entry.path().is_file() { files_vec.push(entry.path().to_str().unwrap().to_string()); } else { folders_vec.push(entry.path().to_str().unwrap().to_string()); } } (files_vec, folders_vec) } async fn priv_delete_files(files: &[String]) { for f in files { tokio::fs::remove_file(f).await.unwrap(); } } async fn priv_delete_folder(folders: &[String]) { for f in folders { let _ = tokio::fs::remove_dir_all(f).await; } } /// Delete a file from the filesystem. /// /// Uses `std::fs` internally. /// ## Examples /// ``` /// use delete::{delete_file}; /// /// fn main() { /// // Delete file.txt /// delete_file("file.txt").unwrap(); /// } /// ``` /// pub fn delete_file(path: &str) -> std::io::Result<()> { std::fs::remove_file(path)?; Ok(()) } /// Delete a file from the filesystem using `async` and `tokio`. /// /// Uses `tokio::fs` internally. /// ## Examples /// ``` /// use delete::{delete_file_async}; /// /// #[tokio::main] /// async fn main() { /// // Delete file.txt /// delete_file_async("file.txt").await.unwrap(); /// } /// ``` /// pub async fn delete_file_async(path: &str) -> std::io::Result<()> { tokio::fs::remove_file(path).await?; Ok(()) } /// Delete an empty folder from the filesystem. /// /// Uses `std::fs` internally. /// ## Examples /// ``` /// use delete::{delete_folder}; /// /// fn main() { /// // Delete tests folder /// delete_folder("tests").unwrap(); /// } /// ``` /// pub fn delete_folder(path: &str) -> std::io::Result<()> { std::fs::remove_dir(path)?; Ok(()) } /// Delete an empty folder from the filesystem using `async` and `tokio`. /// /// Uses `tokio::fs` internally. /// ## Examples /// ``` /// use delete::{delete_folder_async}; /// /// #[tokio::main] /// async fn main() { /// // Delete tests folder /// delete_folder_async("tests").await.unwrap(); /// } /// ``` /// pub async fn delete_folder_async(path: &str) -> std::io::Result<()> { tokio::fs::remove_dir(path).await?; Ok(()) } /// Delete a folder from the filesystem after recursively deleting all its contents. /// /// Uses `std::fs` internally. /// ## Examples /// ``` /// use delete::{delete_folder_all}; /// /// fn main() { /// // Delete node_modules folder and all its contents. /// delete_folder_all("node_modules").unwrap(); /// } /// ``` /// pub fn delete_folder_all(path: &str) -> std::io::Result<()> { std::fs::remove_dir_all(path)?; Ok(()) } /// Delete a folder from the filesystem after recursively deleting all its contents using `async` and `tokio`. /// /// Uses `tokio::fs` internally. /// ## Examples /// ``` /// use delete::{delete_folder_all_async}; /// /// #[tokio::main] /// async fn main() { /// // Delete node_modules folder and all its contents. /// delete_folder_all_async("node_modules").await.unwrap(); /// } /// ``` /// pub async fn delete_folder_all_async(path: &str) -> std::io::Result<()> { tokio::fs::remove_dir_all(path).await?; Ok(()) } /// Rapidly delete a folder from the filesystem after recursively deleting all its contents using `async` and `tokio`. /// /// Benchmarked to be 2-3x faster than `std::fs::remove_dir_all()` /// /// Uses tokio workers to delete files and folders parallely. /// /// ## Parameters /// path: `&str` - path to the folder to delete /// /// (Optional) folders_chunk_size: `Option<u64>` - number of folders to be deleted per worker. /// /// if this value is lower, more workers are spawned. /// (Optional) files_chunk_size: `Option<u64>` - number of files to be deleted per worker. /// /// if this value is lower, more workers are spawned. /// /// Uses `tokio::fs` internally. /// ## Examples /// ``` /// use delete::{rapid_delete_dir_all}; /// /// #[tokio::main] /// async fn main() { /// // Delete node_modules folder and all its contents 2x faster. /// rapid_delete_dir_all("node_modules", None, None).await.unwrap(); /// } /// ``` /// pub async fn rapid_delete_dir_all( path: &str, folders_chunk_size: Option<u64>, files_chunk_size: Option<u64>, ) -> std::io::Result<()> { let (files, directories) = walkdir(path); let mut workers = FuturesUnordered::new(); let file_chunk_size; if files_chunk_size.is_some() { file_chunk_size = files_chunk_size.unwrap(); } else { file_chunk_size = 350; } let chunks = files.chunks(file_chunk_size as usize); for chunk in chunks { workers.push(async move { priv_delete_files(chunk).await; }); } while workers.next().await.is_some() {} let folder_chunk_size; if folders_chunk_size.is_some() { folder_chunk_size = folders_chunk_size.unwrap(); } else { folder_chunk_size = 25; } let folders = directories.chunks(folder_chunk_size as usize); let mut workers = FuturesUnordered::new(); for folder in folders { workers.push(async move { priv_delete_folder(folder).await; }) } while workers.next().await.is_some() {} let _ = std::fs::remove_dir_all(path); Ok(()) }