Struct bdrck::testing::temp::Dir

pub struct Dir { /* fields omitted */ }

A directory within the system's standard temp directory that is automatically deleted when it goes out of scope. The directory is created on construction.

NOTE: For various reasons (e.g. races), temporary directories and files can be very dangerous to rely upon in production code. This struct, as well as File which is based upon it, are primarily intended to be used for unit testing only (thus their placement in the testing submodule).

Methods

impl Dir

pub fn new(prefix: &str) -> Result<Dir>

This is a shortcut version of new_in, which just creates the directory within the system's default temporary directory.

pub fn path(&self) -> &Path

Return the path to this temporary directory.

pub fn sub_path<P: AsRef<Path>>(&self, path: P) -> Result<PathBuf>

A convenience function which adds the given relative path to this temporary directory's absolute path.

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

"Close" this temporary directory, by deleting it along with all of its contents. This is called automatically by the Drop implementation, but it can also be called manually if you want to dispose of this instance without just letting it go out of scope.

Trait Implementations

impl Drop for Dir

fn drop(&mut self)

Executes the destructor for this type.