Struct Transaction 

pub struct Transaction { /* private fields */ }

Several writes staged beside their destinations, renamed over them in order on commit; a staged file that is never committed is removed when the transaction drops.

Implementations

impl Transaction

pub fn new() -> Self

An empty transaction.

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

Stage bytes for path: written whole and synced beside the destination, which holds what it held until commit.

Errors

Any I/O failure from creating or writing the staged file; the destination is untouched.

pub const fn len(&self) -> usize

How many writes are staged.

pub const fn is_empty(&self) -> bool

Whether nothing is staged.

pub fn commit(self) -> Result<Vec<PathBuf>, Interrupted>

Rename every staged file over its destination, in staging order.

Errors

The first rename that fails stops the commit; the result names every destination renamed before it. The remaining staged files are removed, so no destination is ever half-written.

pub fn commit_stopping_at( self, stop: Option<&Path>, ) -> Result<Vec<PathBuf>, Interrupted>

Self::commit, stopped on purpose before the rename over stop, as if that rename had failed. This is the one seam the interruption proof needs: a rename cannot be made to fail from outside without a read failing first, and the proof is about what the tree holds after a commit that stopped part way.

Errors

As Self::commit, plus the injected stop.

Trait Implementations

impl Debug for Transaction

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

Formats the value using the given formatter.

impl Default for Transaction

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Transaction

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.