Struct AtomicWrite 

pub struct AtomicWrite { /* private fields */ }

A file being written through a temporary alongside its destination, replaced by an atomic rename only once the content is complete and durable.

Nothing partial ever appears at the destination path. If the process dies mid-write, the destination is untouched and a .strypt-*.tmp file is left behind — visible, obviously incomplete, and adjacent to where it belongs, rather than a silently truncated file the user might publish.

Implementations

impl AtomicWrite

pub fn begin( destination: &Path, overwrite: Overwrite, permissions: Permissions, ) -> Result<Self>

Begin writing to destination.

Errors

StryptError::OutputExists if the destination exists and overwrite is Overwrite::Refuse; StryptError::Io if the temporary file cannot be created.

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

Write bytes into the temporary file.

Errors

StryptError::Io if the write fails.

pub fn commit(self) -> Result<()>

Flush, synchronise, and atomically move the temporary into place.

The sync_all is not ceremony. Without it the rename can be durable while the content behind it is not, so a crash at the wrong moment leaves a file that exists, has the right name, and contains nothing — which for this tool means a user with a file they believe is a stripped copy of their document.

Errors

StryptError::Io if syncing or renaming fails. The temporary is removed either way.

pub fn abort(self)

Abandon the write, leaving the destination untouched.

Trait Implementations

impl Debug for AtomicWrite

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

Formats the value using the given formatter.

impl Drop for AtomicWrite

fn drop(&mut self)

Removes the temporary if the writer was neither committed nor aborted.

This is the path taken when a handler returns Err mid-write, which is the normal way a fail-closed handler gives up. Without it, every failed strip would litter a partial file next to the user’s document.

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.