Struct assert_fs::fixture::TempDir

pub struct TempDir { /* fields omitted */ }

A directory in the filesystem that is automatically deleted when it goes out of scope.

The TempDir type creates a directory on the file system that is deleted once it goes out of scope. At construction, the TempDir creates a new directory with a randomly generated name.

The constructor, TempDir::new(), creates directories in the location returned by std::env::temp_dir().

After creating a TempDir, work with the file system by doing standard std::fs file system operations on its Path, which can be retrieved with TempDir::path(). Once the TempDir value is dropped, the directory at the path will be deleted, along with any files and directories it contains. It is your responsibility to ensure that no further file system operations are attempted inside the temporary directory once it has been deleted.

Resource Leaking

Various platform-specific conditions may cause TempDir to fail to delete the underlying directory. It's important to ensure that handles (like File and ReadDir) to files inside the directory are dropped before the TempDir goes out of scope. The TempDir destructor will silently ignore any errors in deleting the directory; to instead handle errors call TempDir::close().

Note that if the program exits before the TempDir destructor is run, such as via std::process::exit(), by segfaulting, or by receiving a signal like SIGINT, then the temporary directory will not be deleted.

Examples

Create a temporary directory with a generated name:

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new().unwrap();

// Ensure deletion happens.
tmp_dir.close().unwrap();

Implementations

impl TempDir

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

Attempts to make a temporary directory inside of env::temp_dir().

The directory and everything inside it will be automatically deleted once the returned TempDir is destroyed.

Errors

If the directory can not be created, Err is returned.

Examples

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new().unwrap();

// Ensure deletion happens.
tmp_dir.close().unwrap();

pub fn into_persistent_if(self, yes: bool) -> Self

Conditionally persist the temporary directory for debug purposes.

Note: this operation is not reversible, i.e. into_persistent_if(false) is a no-op.

Examples

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new()
    .unwrap()
    .into_persistent_if(std::env::var_os("TEST_PERSIST_FILES").is_some());

// Ensure deletion happens.
tmp_dir.close().unwrap();

pub fn into_persistent(self) -> Self

Persist the temporary directory for debug purposes.

Note: this operation is not reversible, i.e. into_persistent_if(false) is a no-op.

Examples

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new()
    .unwrap()
    .into_persistent();

// Ensure deletion happens.
tmp_dir.close().unwrap();

pub fn path(&self) -> &Path

Accesses the Path to the temporary directory.

Examples

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new().unwrap();

println!("{}", tmp_dir.path().display());

// Ensure deletion happens.
tmp_dir.close().unwrap();

pub fn close(self) -> Result<(), FixtureError>

Closes and removes the temporary directory, returing a Result.

Although TempDir removes the directory on drop, in the destructor any errors are ignored. To detect errors cleaning up the temporary directory, call close instead.

Errors

This function may return a variety of std::io::Errors that result from deleting the files and directories contained with the temporary directory, as well as from deleting the temporary directory itself. These errors may be platform specific.

Examples

use assert_fs::fixture::TempDir;

let tmp_dir = TempDir::new().unwrap();

// Ensure deletion happens.
tmp_dir.close().unwrap();

Trait Implementations

impl PathAssert for TempDir

fn assert<I, P>(&self, pred: I) -> &Self where
    I: IntoPathPredicate<P>,
    P: Predicate<Path>, 

Assert the state of files within TempDir.

impl PathChild for TempDir

fn child<P>(&self, path: P) -> ChildPath where
    P: AsRef<Path>, 

Access a path within the temp directory.

impl PathCopy for TempDir

fn copy_from<P, S>(&self, source: P, patterns: &[S]) -> Result<(), FixtureError> where
    P: AsRef<Path>,
    S: AsRef<str>, 

Copy files and directories into the current path from the source according to the glob patterns.