Struct TmpDir

pub struct TmpDir(/* private fields */);

Handle a temporary directory.

The path parameter (present in some methods) must be relative because it will be joined to the temporary directory path.

When this struct is dropped, the temporary directory itself is automatically deleted.

Implementations

impl TmpDir

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

Create a new TmpDir instance.

pub fn path(&self) -> PathBuf

Path of the temporary directory.

pub fn unique_path(&self) -> PathBuf

Generate a new unique path in the temporary directory.

pub fn write_file<P, C>(&self, path: P, contents: C) -> Result<()>

where P: AsRef<Path>, C: AsRef<[u8]>,

Write to a file (or create it if it doesn’t exist) in the temporary directory. Akin to fs::write.

pub fn read_file<P>(&self, path: P) -> Result<Vec<u8>>

where P: AsRef<Path>,

Read a file in the temporary directory. Akin to fs::read.

pub fn create_dir<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Create a directory inside the temporary directory. Akin to fs::create_dir.

pub fn create_dir_all<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Create a directory and all of its parent components if they are missing. Akin to fs::create_dir_all.

pub fn create_file<P>(&self, path: P) -> Result<File>

where P: AsRef<Path>,

Create a file in the temporary directory and open it in write-only mode. Akin to File::create.

pub fn open_readable<P>(&self, path: P) -> Result<File>

where P: AsRef<Path>,

Open a file in the temporary directory in read-only mode. Akin to File::open.

pub fn open_writable<P>(&self, path: P) -> Result<File>

where P: AsRef<Path>,

Open a file in the temporary directory in write-only mode.

pub fn open_with_opts<P>(&self, opts: &mut OpenOptions, path: P) -> Result<File>

where P: AsRef<Path>,

Open a file in the temporary directory using the provided OpenOptions. Akin to fs::OpenOptions::open.

pub fn metadata<P>(&self, path: P) -> Result<Metadata>

where P: AsRef<Path>,

Get metadata for the given path. Akin to fs::metadata.

pub fn exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Check if a path exists in the current directory. Akin to Path::exists.

pub fn read_dir<P>(&self, path: P) -> Result<ReadDir>

where P: AsRef<Path>,

Read temporary directory. Akin to fs::read_dir.

pub fn remove_file<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Remove a file in the current directory. Akin to fs::remove_file.

pub fn remove_dir<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Remove a directory in the current directory. Akin to fs::remove_dir.

pub fn remove_dir_all<P>(&self, path: P) -> Result<()>

where P: AsRef<Path>,

Remove a directory and all its contents in the current directory. Akin to fs::remove_dir_all.

Trait Implementations

impl Drop for TmpDir

fn drop(&mut self)

When TmpDir is dropped, the temporary directory itself is deleted.