Struct CleanDir 

pub struct CleanDir<T>(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::traits::sync::DirStructureItem;
use dir_structure::clean_dir::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<T> AssertEq for CleanDir<T>

where for<'__trivial> T: AssertEq<T> + Debug,

fn assert_eq( &self, other: &Self, path: &mut AssertPath, init_left: &impl Display, init_right: &impl Display, )

Asserts that self is equal to other, panicking if they are not equal.

impl<T: Clone> Clone for CleanDir<T>

fn clone(&self) -> CleanDir<T>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for CleanDir<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> DynamicHasField for CleanDir<T>

where T: DynamicHasField,

Available on crate feature resolve-path only.

type Inner = <T as DynamicHasField>::Inner

The type of the field.

fn resolve_path<P: OwnedPathType>(p: P, name: &str) -> P

How to resolve the path for the field, from the path of Self, given the name passed into the resolve_path! macro.

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

where T: WriteTo<'vfs, Vfs> + 'a, Vfs: 'vfs + WriteSupportingVfs<'vfs>, 'vfs: 'a,

type Inner = T

The inner type to cast.

type Wr = CleanDirRefWr<'a, 'vfs, T, Vfs>

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<'a, T, Vfs: WriteSupportingVfsAsync + 'static> FromRefForWriterAsync<'a, Vfs> for CleanDir<T>

where T: WriteToAsyncRef<'a, Vfs> + Send + Sync + 'static, for<'f> <Vfs as VfsAsync>::ExistsFuture<'f>: Future<Output = VfsResult<bool, Vfs>> + Unpin + 'f, for<'f> <Vfs as WriteSupportingVfsAsync>::RemoveDirAllFuture<'f>: Future<Output = VfsResult<(), Vfs>> + Unpin + 'f,

Available on crate feature async only.

type Inner = T

The inner type to cast.

type Wr = CleanDirRefWr<'a, 'a, T, Vfs>

The reference type to cast to.

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

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

impl<const NAME: [char; 32], T> HasField<NAME> for CleanDir<T>

where T: HasField<NAME>,

Available on crate feature resolve-path only.

type Inner = <T as HasField<NAME>>::Inner

The type of the field.

fn resolve_path<P: OwnedPathType>(p: P) -> P

How to resolve the path for the field, from the path of Self.

impl<T: Hash> Hash for CleanDir<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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: Ord> Ord for CleanDir<T>

fn cmp(&self, other: &CleanDir<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for CleanDir<T>

fn eq(&self, other: &CleanDir<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for CleanDir<T>

fn partial_cmp(&self, other: &CleanDir<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a, T, Vfs: Vfs<'a>> ReadFrom<'a, Vfs> for CleanDir<T>

where T: ReadFrom<'a, Vfs>,

fn read_from(path: &Vfs::Path, vfs: Pin<&'a Vfs>) -> VfsResult<Self, Vfs>

where Self: Sized,

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

impl<'a, T, Vfs: VfsAsync + 'a> ReadFromAsync<'a, Vfs> for CleanDir<T>

where T: ReadFromAsync<'a, Vfs> + Send + 'static,

Available on crate feature async only.

type Future = Pin<Box<dyn Future<Output = Result<CleanDir<T>, Error<<<Vfs as VfsCore>::Path as PathType>::OwnedPath>>> + Send + 'a>>

The future type returned by the async read function.

fn read_from_async( path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'a Vfs>, ) -> Self::Future

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

impl<'a, T, Vfs: WriteSupportingVfs<'a>> WriteTo<'a, Vfs> for CleanDir<T>

where T: WriteTo<'a, Vfs>,

fn write_to(&self, path: &Vfs::Path, vfs: Pin<&'a Vfs>) -> VfsResult<(), Vfs>

Writes the structure to the specified path.

impl<'a, T, Vfs: WriteSupportingVfsAsync + 'static> WriteToAsync<'a, Vfs> for CleanDir<T>

where T: WriteToAsync<'a, Vfs> + Send + Sync + 'static,

Available on crate feature async only.

type Future = Pin<Box<dyn Future<Output = Result<(), Error<<<Vfs as VfsCore>::Path as PathType>::OwnedPath>>> + Send + 'a>>

The future type returned by the async write function.

fn write_to_async( self, path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'a Vfs>, ) -> Self::Future

Asynchronously writes the structure to the specified path.

impl<'a, T, Vfs: WriteSupportingVfsAsync + 'static> WriteToAsyncRef<'a, Vfs> for CleanDir<T>

where T: WriteToAsyncRef<'a, Vfs> + Send + Sync + 'static, for<'f> <T as WriteToAsyncRef<'a, Vfs>>::Future<'f>: Future<Output = VfsResult<(), Vfs>> + Unpin + 'f, for<'f> <Vfs as VfsAsync>::ExistsFuture<'f>: Future<Output = VfsResult<bool, Vfs>> + Unpin + 'f, for<'f> <Vfs as WriteSupportingVfsAsync>::RemoveDirAllFuture<'f>: Future<Output = VfsResult<(), Vfs>> + Unpin + 'f,

Available on crate feature async only.

type Future<'b> = CleanDirWriteRefFuture<'a, 'b, T, Vfs> where Self: 'b, Vfs: 'b, 'a: 'b

The future type returned by the async write function.

fn write_to_async_ref<'b>( &'b self, path: <<Vfs as VfsCore>::Path as PathType>::OwnedPath, vfs: Pin<&'b Vfs>, ) -> Self::Future<'b>

where 'a: 'b,

Asynchronously writes the structure to the specified path.

impl<T: Copy> Copy for CleanDir<T>

impl<T: Eq> Eq for CleanDir<T>

impl<T> StructuralPartialEq for CleanDir<T>