Struct DropDir

pub struct DropDir { /* private fields */ }

Represents a Directory that will be automatically deleted when it goes out of scope.

Example

use std::path::PathBuf;
use drop_dir::DropDir;
use std::fs::File;

let drop_dir = DropDir::new(PathBuf::from("/tmp/some/path")).unwrap();
let mut file = File::create(drop_dir.path().join("file.txt")).unwrap();
// drop_dir deleted when it goes out of scope.

Limitation

In the example above, only the last component of the drop_dir is removed. That is, the dir /tmp/some/temp/path is deleted, but /tmp/some/temp remains. Any other behavior would get complicated.

Implementations

impl DropDir

pub fn new(path_buf: PathBuf) -> Result<DropDir, Error>

new

Constructs a new DropDir object from a PathBuf. Creates the directory at PathBuf if it does not exist (using fs::create_dir_all).

Example

let drop_dir = DropDir::new(PathBuf::from("/tmp/some/path")).unwrap();

pub fn path(&self) -> PathBuf

path

Returns a clone of the internally held PathBuf.

Example

let path_str = drop_dir.path().to_string_lossy();

Trait Implementations

impl Drop for DropDir

fn drop(&mut self)

Executes the destructor for this type.