Struct temp_dir::TempDir

pub struct TempDir { /* fields omitted */ }

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

Recursively deletes the directory and its contents on drop. Ignores any error while deleting.

Example

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

Implementations

impl TempDir

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

Create a new empty directory in a system temporary directory.

Drop the returned struct to delete the directory and everything under it.

Errors

Returns Err when it fails to create the directory.

Example

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

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

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

Drop the returned struct to delete the directory and everything under it.

Errors

Returns Err when it fails to create the directory.

Example

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

#[must_use]pub fn path(&self) -> &Path

The path to the directory.

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

The path to name under the directory.

Trait Implementations

impl Clone for TempDir

fn clone(&self) -> TempDir

Returns a copy of the value.

pub 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 PartialEq<TempDir> for TempDir

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<TempDir> for TempDir

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl StructuralPartialEq for TempDir