Struct TempDir

pub struct TempDir { /* private fields */ }

Wrapper over a temporary directory.

The directory will be maintained for the lifetime of the TempDir object.

Implementations

impl TempDir

pub fn new_with_prefix<P: AsRef<OsStr>>(prefix: P) -> Result<TempDir>

Creates a new temporary directory with prefix.

The directory will be removed when the object goes out of scope.

Examples

let t = TempDir::new_with_prefix("/tmp/testdir").unwrap();

pub fn new_in(path: &Path) -> Result<TempDir>

Creates a new temporary directory with inside path.

The directory will be removed when the object goes out of scope.

Examples

let t = TempDir::new_in(Path::new("/tmp/")).unwrap();

pub fn new() -> Result<TempDir>

Creates a new temporary directory with inside $TMPDIR if set, otherwise in /tmp.

The directory will be removed when the object goes out of scope.

Examples

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

pub fn remove(&self) -> Result<()>

Removes the temporary directory.

Calling this is optional as when a TempDir object goes out of scope, the directory will be removed. Calling remove explicitly allows for better error handling.

Errors

This function can only be called once per object. An error is returned otherwise.

Examples

let temp_dir = TempDir::new_with_prefix("/tmp/testdir").unwrap();
temp_dir.remove().unwrap();

pub fn as_path(&self) -> &Path

Returns the path to the tempdir.

Examples

let temp_dir = TempDir::new_with_prefix("/tmp/testdir").unwrap();
assert!(temp_dir.as_path().exists());

Trait Implementations

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.