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 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
//! Temporary files and directories. //! //! - Use the [`tempfile()`] function for temporary files //! - Use the [`tempdir()`] function for temporary directories. //! //! # Design //! //! This crate provides several approaches to creating temporary files and directories. //! [`tempfile()`] relies on the OS to remove the temporary file once the last handle is closed. //! [`TempDir`] and [`NamedTempFile`] both rely on Rust destructors for cleanup. //! //! When choosing between the temporary file variants, prefer `tempfile` //! unless you either need to know the file's path or to be able to persist it. //! //! ## Resource Leaking //! //! `tempfile` will (almost) never fail to cleanup temporary resources, but `TempDir` and `NamedTempFile` will if //! their destructors don't run. This is because `tempfile` relies on the OS to cleanup the //! underlying file, while `TempDir` and `NamedTempFile` rely on their destructors to do so. //! //! ## Security //! //! In the presence of pathological temporary file cleaner, relying on file paths is unsafe because //! a temporary file cleaner could delete the temporary file which an attacker could then replace. //! //! `tempfile` doesn't rely on file paths so this isn't an issue. However, `NamedTempFile` does //! rely on file paths for _some_ operations. See the security documentation on //! the `NamedTempFile` type for more information. //! //! ## Examples //! //! Create a temporary file and write some data into it: //! //! ``` //! use tempfile::tempfile; //! use std::io::{self, Write}; //! //! # fn main() { //! # if let Err(_) = run() { //! # ::std::process::exit(1); //! # } //! # } //! # fn run() -> Result<(), io::Error> { //! // Create a file inside of `std::env::temp_dir()`. //! let mut file = tempfile()?; //! //! writeln!(file, "Brian was here. Briefly.")?; //! # Ok(()) //! # } //! ``` //! //! Create a named temporary file and open an independent file handle: //! //! ``` //! use tempfile::NamedTempFile; //! use std::io::{self, Write, Read}; //! //! # fn main() { //! # if let Err(_) = run() { //! # ::std::process::exit(1); //! # } //! # } //! # fn run() -> Result<(), io::Error> { //! let text = "Brian was here. Briefly."; //! //! // Create a file inside of `std::env::temp_dir()`. //! let mut file1 = NamedTempFile::new()?; //! //! // Re-open it. //! let mut file2 = file1.reopen()?; //! //! // Write some test data to the first handle. //! file1.write_all(text.as_bytes())?; //! //! // Read the test data using the second handle. //! let mut buf = String::new(); //! file2.read_to_string(&mut buf)?; //! assert_eq!(buf, text); //! # Ok(()) //! # } //! ``` //! //! Create a temporary directory and add a file to it: //! //! ``` //! use tempfile::tempdir; //! use std::fs::File; //! use std::io::{self, Write}; //! //! # fn main() { //! # if let Err(_) = run() { //! # ::std::process::exit(1); //! # } //! # } //! # fn run() -> Result<(), io::Error> { //! // Create a directory inside of `std::env::temp_dir()`. //! let dir = tempdir()?; //! //! let file_path = dir.path().join("my-temporary-note.txt"); //! let mut file = File::create(file_path)?; //! writeln!(file, "Brian was here. Briefly.")?; //! //! // By closing the `TempDir` explicitly, we can check that it has //! // been deleted successfully. If we don't close it explicitly, //! // the directory will still be deleted when `dir` goes out //! // of scope, but we won't know whether deleting the directory //! // succeeded. //! drop(file); //! dir.close()?; //! # Ok(()) //! # } //! ``` //! //! [`tempfile()`]: fn.tempfile.html //! [`tempdir()`]: fn.tempdir.html //! [`TempDir`]: struct.TempDir.html //! [`NamedTempFile`]: struct.NamedTempFile.html //! [`std::env::temp_dir()`]: https://doc.rust-lang.org/std/env/fn.temp_dir.html #![doc( html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png", html_favicon_url = "https://www.rust-lang.org/favicon.ico", html_root_url = "https://docs.rs/tempfile/3.1.0" )] #![cfg_attr(test, deny(warnings))] #![deny(rust_2018_idioms)] #![allow(clippy::redundant_field_names)] #[macro_use] extern crate cfg_if; const NUM_RETRIES: u32 = 1 << 31; const NUM_RAND_CHARS: usize = 6; use std::ffi::OsStr; use std::fs::OpenOptions; use std::path::Path; use std::{env, io}; mod dir; mod error; mod file; mod spooled; mod util; pub use crate::dir::{tempdir, tempdir_in, TempDir}; pub use crate::file::{ tempfile, tempfile_in, NamedTempFile, PathPersistError, PersistError, TempPath, }; pub use crate::spooled::{spooled_tempfile, SpooledTempFile}; /// Create a new temporary file or directory with custom parameters. #[derive(Debug, Clone, Eq, PartialEq)] pub struct Builder<'a, 'b> { random_len: usize, prefix: &'a OsStr, suffix: &'b OsStr, append: bool, } impl<'a, 'b> Default for Builder<'a, 'b> { fn default() -> Self { Builder { random_len: crate::NUM_RAND_CHARS, prefix: OsStr::new(".tmp"), suffix: OsStr::new(""), append: false, } } } impl<'a, 'b> Builder<'a, 'b> { /// Create a new `Builder`. /// /// # Examples /// /// Create a named temporary file and write some data into it: /// /// ``` /// # use std::io; /// # use std::ffi::OsStr; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// use tempfile::Builder; /// /// let named_tempfile = Builder::new() /// .prefix("my-temporary-note") /// .suffix(".txt") /// .rand_bytes(5) /// .tempfile()?; /// /// let name = named_tempfile /// .path() /// .file_name().and_then(OsStr::to_str); /// /// if let Some(name) = name { /// assert!(name.starts_with("my-temporary-note")); /// assert!(name.ends_with(".txt")); /// assert_eq!(name.len(), "my-temporary-note.txt".len() + 5); /// } /// # Ok(()) /// # } /// ``` /// /// Create a temporary directory and add a file to it: /// /// ``` /// # use std::io::{self, Write}; /// # use std::fs::File; /// # use std::ffi::OsStr; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// use tempfile::Builder; /// /// let dir = Builder::new() /// .prefix("my-temporary-dir") /// .rand_bytes(5) /// .tempdir()?; /// /// let file_path = dir.path().join("my-temporary-note.txt"); /// let mut file = File::create(file_path)?; /// writeln!(file, "Brian was here. Briefly.")?; /// /// // By closing the `TempDir` explicitly, we can check that it has /// // been deleted successfully. If we don't close it explicitly, /// // the directory will still be deleted when `dir` goes out /// // of scope, but we won't know whether deleting the directory /// // succeeded. /// drop(file); /// dir.close()?; /// # Ok(()) /// # } /// ``` pub fn new() -> Self { Self::default() } /// Set a custom filename prefix. /// /// Path separators are legal but not advisable. /// Default: `.tmp`. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let named_tempfile = Builder::new() /// .prefix("my-temporary-note") /// .tempfile()?; /// # Ok(()) /// # } /// ``` pub fn prefix<S: AsRef<OsStr> + ?Sized>(&mut self, prefix: &'a S) -> &mut Self { self.prefix = prefix.as_ref(); self } /// Set a custom filename suffix. /// /// Path separators are legal but not advisable. /// Default: empty. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let named_tempfile = Builder::new() /// .suffix(".txt") /// .tempfile()?; /// # Ok(()) /// # } /// ``` pub fn suffix<S: AsRef<OsStr> + ?Sized>(&mut self, suffix: &'b S) -> &mut Self { self.suffix = suffix.as_ref(); self } /// Set the number of random bytes. /// /// Default: `6`. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let named_tempfile = Builder::new() /// .rand_bytes(5) /// .tempfile()?; /// # Ok(()) /// # } /// ``` pub fn rand_bytes(&mut self, rand: usize) -> &mut Self { self.random_len = rand; self } /// Set the file to be opened in append mode. /// /// Default: `false`. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let named_tempfile = Builder::new() /// .append(true) /// .tempfile()?; /// # Ok(()) /// # } /// ``` pub fn append(&mut self, append: bool) -> &mut Self { self.append = append; self } /// Create the named temporary file. /// /// # Security /// /// See [the security][security] docs on `NamedTempFile`. /// /// # Resource leaking /// /// See [the resource leaking][resource-leaking] docs on `NamedTempFile`. /// /// # Errors /// /// If the file cannot be created, `Err` is returned. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let tempfile = Builder::new().tempfile()?; /// # Ok(()) /// # } /// ``` /// /// [security]: struct.NamedTempFile.html#security /// [resource-leaking]: struct.NamedTempFile.html#resource-leaking pub fn tempfile(&self) -> io::Result<NamedTempFile> { self.tempfile_in(&env::temp_dir()) } /// Create the named temporary file in the specified directory. /// /// # Security /// /// See [the security][security] docs on `NamedTempFile`. /// /// # Resource leaking /// /// See [the resource leaking][resource-leaking] docs on `NamedTempFile`. /// /// # Errors /// /// If the file cannot be created, `Err` is returned. /// /// # Examples /// /// ``` /// # use std::io; /// # fn main() { /// # if let Err(_) = run() { /// # ::std::process::exit(1); /// # } /// # } /// # fn run() -> Result<(), io::Error> { /// # use tempfile::Builder; /// let tempfile = Builder::new().tempfile_in("./")?; /// # Ok(()) /// # } /// ``` /// /// [security]: struct.NamedTempFile.html#security /// [resource-leaking]: struct.NamedTempFile.html#resource-leaking pub fn tempfile_in<P: AsRef<Path>>(&self, dir: P) -> io::Result<NamedTempFile> { util::create_helper( dir.as_ref(), self.prefix, self.suffix, self.random_len, |path| file::create_named(path, OpenOptions::new().append(self.append)), ) } /// Attempts to make a temporary directory inside of `env::temp_dir()` whose /// name will have the prefix, `prefix`. The directory and /// everything inside it will be automatically deleted once the /// returned `TempDir` is destroyed. /// /// # Resource leaking /// /// See [the resource leaking][resource-leaking] docs on `TempDir`. /// /// # Errors /// /// If the directory can not be created, `Err` is returned. /// /// # Examples /// /// ``` /// use std::fs::File; /// use std::io::Write; /// use tempfile::Builder; /// /// # use std::io; /// # fn run() -> Result<(), io::Error> { /// let tmp_dir = Builder::new().tempdir()?; /// # Ok(()) /// # } /// ``` /// /// [resource-leaking]: struct.TempDir.html#resource-leaking pub fn tempdir(&self) -> io::Result<TempDir> { self.tempdir_in(&env::temp_dir()) } /// Attempts to make a temporary directory inside of `dir`. /// The directory and everything inside it will be automatically /// deleted once the returned `TempDir` is destroyed. /// /// # Resource leaking /// /// See [the resource leaking][resource-leaking] docs on `TempDir`. /// /// # Errors /// /// If the directory can not be created, `Err` is returned. /// /// # Examples /// /// ``` /// use std::fs::{self, File}; /// use std::io::Write; /// use tempfile::Builder; /// /// # use std::io; /// # fn run() -> Result<(), io::Error> { /// let tmp_dir = Builder::new().tempdir_in("./")?; /// # Ok(()) /// # } /// ``` /// /// [resource-leaking]: struct.TempDir.html#resource-leaking pub fn tempdir_in<P: AsRef<Path>>(&self, dir: P) -> io::Result<TempDir> { let storage; let mut dir = dir.as_ref(); if !dir.is_absolute() { let cur_dir = env::current_dir()?; storage = cur_dir.join(dir); dir = &storage; } util::create_helper(dir, self.prefix, self.suffix, self.random_len, dir::create) } }