Struct AtomicFile

pub struct AtomicFile { /* private fields */ }

Create a file and write to it atomically, in a callback.

Implementations

impl AtomicFile

pub fn new<P>(path: P, overwrite: OverwriteBehavior) -> Self

where P: AsRef<Path>,

Helper for writing to the file at path atomically, in write-only mode.

If OverwriteBehaviour::DisallowOverwrite is given, an Error::Internal containing an std::io::ErrorKind::AlreadyExists will be returned from self.write(...) if the file exists.

The temporary file is written to a temporary subdirectory in ., to ensure it’s on the same filesystem (so that the move is atomic).

pub fn new_with_tmpdir<P, Q>( path: P, overwrite: OverwriteBehavior, tmpdir: Q, ) -> Self

where P: AsRef<Path>, Q: AsRef<Path>,

Like AtomicFile::new, but the temporary file is written to a temporary subdirectory in tmpdir.

TODO: does tmpdir have to exist?

pub fn path(&self) -> &Path

Get the target filepath.

pub fn write<T, E, F>(&self, f: F) -> Result<T, Error<E>>

where F: FnOnce(&mut File) -> Result<T, E>,

Open a temporary file, call f on it (which is supposed to write to it), then move the file atomically to self.path.

The temporary file is written to a randomized temporary subdirectory with prefix .atomicwrite.

pub fn write_with_options<T, E, F>( &self, f: F, options: OpenOptions, ) -> Result<T, Error<E>>

where F: FnOnce(&mut File) -> Result<T, E>,

Open a temporary file with custom OpenOptions, call f on it (which is supposed to write to it), then move the file atomically to self.path.

The temporary file is written to a randomized temporary subdirectory with prefix .atomicwrite.