Struct TempDir

pub struct TempDir { /* private fields */ }

The path of an existing writable directory in a system temporary directory.

Drop the struct to delete the directory and everything under it. Deletes symbolic links and does not follow them.

Ignores any error while deleting. See TempDir::panic_on_cleanup_error.

Example

use temp_dir::TempDir;
let d = TempDir::new().unwrap();
// Prints "/tmp/t1a9b-0".
println!("{:?}", d.path());
let f = d.child("file1");
// Prints "/tmp/t1a9b-0/file1".
println!("{:?}", f);
std::fs::write(&f, b"abc").unwrap();
assert_eq!(
    "abc",
    std::fs::read_to_string(&f).unwrap(),
);
// Prints "/tmp/t1a9b-1".
println!("{:?}", TempDir::new().unwrap().path());

Implementations

impl TempDir

pub fn new() -> Result<Self, Error>

Create a new empty directory in a system temporary directory.

Drop the struct to delete the directory and everything under it. Deletes symbolic links and does not follow them.

Ignores any error while deleting. See TempDir::panic_on_cleanup_error.

Errors

Returns Err when it fails to create the directory.

Example

// Prints "/tmp/t1a9b-0".
println!("{:?}", temp_dir::TempDir::new().unwrap().path());

pub fn with_prefix(prefix: impl AsRef<str>) -> Result<Self, Error>

Create a new empty directory in a system temporary directory. Use prefix as the first part of the directory’s name.

Drop the struct to delete the directory and everything under it. Deletes symbolic links and does not follow them.

Ignores any error while deleting. See TempDir::panic_on_cleanup_error.

Errors

Returns Err when it fails to create the directory.

Example

// Prints "/tmp/ok1a9b-0".
println!("{:?}", temp_dir::TempDir::with_prefix("ok").unwrap().path());

pub fn cleanup(self) -> Result<(), Error>

Remove the directory and its contents now.

Errors

Returns an error if the directory exists and we fail to remove it and its contents.

pub fn panic_on_cleanup_error(self) -> Self

Make the struct panic on drop if it hits an error while removing the directory or its contents.

pub fn leak(self)

Do not delete the directory or its contents.

This is useful when debugging a test.

pub fn path(&self) -> &Path

The path to the directory.

pub fn child(&self, name: impl AsRef<str>) -> PathBuf

The path to name under the directory.

Trait Implementations

impl AsRef<Path> for TempDir

fn as_ref(&self) -> &Path

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TempDir

fn clone(&self) -> TempDir

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TempDir

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for TempDir

fn drop(&mut self)

Executes the destructor for this type.

impl Hash for TempDir

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for TempDir

fn cmp(&self, other: &TempDir) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TempDir

fn eq(&self, other: &TempDir) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for TempDir

fn partial_cmp(&self, other: &TempDir) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TempDir

impl StructuralPartialEq for TempDir