Struct AtomicOutputFile 

pub struct AtomicOutputFile {
    tmp_path: PathBuf,
    final_path: PathBuf,
    file: Option<File>,
}

Crash-safe output writing: content goes to a hidden temporary file next to final_path, and AtomicOutputFile::commit fsyncs it and renames it into place. Until then the final path holds whatever the caller put there (typically an empty placeholder claiming the name), so a crash or error never leaves a truncated file that looks complete. Dropping without committing removes the temporary file.

A hard crash (kill, power loss) can still leave the empty placeholder and a .<name>.tmpN file behind; both are inert and safe to delete manually. We deliberately never auto-clean them: deleting files we cannot prove we created is worse than the litter.

Fields

tmp_path: PathBuf

final_path: PathBuf

file: Option<File>

Implementations

impl AtomicOutputFile

pub fn start(final_path: PathBuf) -> Result<AtomicOutputFile, WorkflowError>

Starts writing for final_path, which the caller must already have claimed (created) so the name is reserved under its own overwrite policy.

pub fn as_file(&self) -> &File

The temporary file being written, e.g. to apply metadata before committing (rename preserves it).

pub fn commit(&mut self) -> Result<(), WorkflowError>

Flushes the content to disk and atomically renames it over the final path (replacing the caller’s placeholder).

Trait Implementations

impl Drop for AtomicOutputFile

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Write for AtomicOutputFile

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.