Struct CleanDir

pub struct CleanDir<T: DirStructureItem>(pub T);

A newtype that will clean the directory it is written to, before writing the value.

This is useful when we want to write a directory structure, but we want to make sure that the directory is clean before writing it, so that there are no old files / directories left in it.

use std::path::Path;

use dir_structure::DirStructureItem;
use dir_structure::CleanDir;

#[derive(dir_structure::DirStructure)]
struct Dir {
   #[dir_structure(path = "f.txt")]
   f: String,
}

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let d = Path::new("dir");
    std::fs::create_dir_all(&d)?;
    std::fs::write(d.join("f.txt"), "Hello, world!")?;
    std::fs::write(d.join("f2.txt"), "Hello, world! (2)")?;
    let dir = Dir::read(&d)?;
    assert_eq!(dir.f, "Hello, world!");
    assert_eq!(std::fs::read_to_string(d.join("f2.txt"))?, "Hello, world! (2)");
    CleanDir(dir).write(&d)?;
    assert_eq!(std::fs::read_to_string(d.join("f.txt"))?, "Hello, world!");
    assert!(!d.join("f2.txt").exists());
    Ok(())
}

Tuple Fields

0: T

Trait Implementations

impl<'a, T> FromRefForWriter<'a> for CleanDir<T>

where T: DirStructureItem + 'a,

type Inner = T

The inner type to cast.

type Wr = CleanDirRefWr<'a, T>

The reference type to cast to.

fn from_ref_for_writer(value: &'a Self::Inner) -> Self::Wr

Casts the reference to the inner type to a WriteTo reference type.

impl<T> NewtypeToInner for CleanDir<T>

where T: DirStructureItem,

type Inner = T

The inner type.

fn into_inner(self) -> Self::Inner

Converts the newtype to its inner type.

impl<T> ReadFrom for CleanDir<T>

where T: DirStructureItem,

fn read_from(path: &Path) -> Result<Self>

where Self: Sized,

Reads the structure from the specified path, which can be either a file or a directory.

impl<T> WriteTo for CleanDir<T>

where T: DirStructureItem,

fn write_to(&self, path: &Path) -> Result<()>

Writes the structure to the specified path.