Struct AtomicDir 

pub struct AtomicDir<T>(pub T);

A wrapper type that enables atomic writes to directories.

When writing, it first writes to a temporary directory and then renames it to the target directory, ensuring that the target directory is never left in a partially updated state.

If the write fails, the original directory remains unchanged, and the temporary directory is cleaned up, before the error is propagated.

The Vfs used for writing must support temporary directories via the VfsSupportsTemporaryDirectories trait (or its async counterpart VfsSupportsTemporaryDirectoriesAsync when using async writes).

Tuple Fields

0: T

Trait Implementations

impl<'vfs, T, Vfs: Vfs<'vfs> + 'vfs> ReadFrom<'vfs, Vfs> for AtomicDir<T>

where T: ReadFrom<'vfs, Vfs>,

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

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

impl<'vfs, T, Vfs: VfsAsync + 'vfs> ReadFromAsync<'vfs, Vfs> for AtomicDir<T>

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

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

Available on crate feature async only.

The future type returned by the async read function.

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

Available on crate feature async only.

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

impl<'vfs, T, Vfs> WriteTo<'vfs, Vfs> for AtomicDir<T>

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

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

Writes the structure to the specified path.

impl<'vfs, T, Vfs> WriteToAsync<'vfs, Vfs> for AtomicDir<T>

where T: WriteToAsync<'vfs, Vfs> + Send + 'static, Vfs: VfsSupportsTemporaryDirectoriesAsync<'vfs> + VfsAsync + Send + WriteSupportingVfsAsync + 'vfs,

Available on crate feature async only.

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

The future type returned by the async write function.

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

Asynchronously writes the structure to the specified path.

impl<'vfs, T, Vfs> WriteToAsyncRef<'vfs, Vfs> for AtomicDir<T>

where T: WriteToAsyncRef<'vfs, Vfs> + Sync + 'static, for<'r> <T as WriteToAsyncRef<'vfs, Vfs>>::Future<'r>: Future<Output = VfsResult<(), Vfs>> + Unpin + Send + 'r, for<'r> Vfs: VfsSupportsTemporaryDirectoriesAsync<'r> + VfsAsync + Send + 'static + WriteSupportingVfsAsync + 'vfs,

Available on crate feature async only.

type Future<'r> = AtomicDirWriteToAsyncRefFuture<'r, 'vfs, T, Vfs> where Self: 'r, 'vfs: 'r

The future type returned by the async write function.

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

where 'vfs: 'r,

Asynchronously writes the structure to the specified path.