Struct SetupTransaction 

pub struct SetupTransaction { /* private fields */ }

A staged multi-file write that either fully applies or fully rolls back.

Stage every file the setup step intends to write, then call commit. If any single write fails, every already-applied write in the transaction is restored to its pre-commit contents (or removed if it did not previously exist), and the original error is returned. A transaction that is dropped without committing leaves the filesystem untouched.

Implementations

impl SetupTransaction

pub fn new() -> Self

Create an empty transaction.

pub fn stage( &mut self, path: impl Into<PathBuf>, bytes: impl Into<Vec<u8>>, ) -> &mut Self

Stage bytes to be written to path on commit.

Staging touches nothing on disk. A later stage for the same path replaces an earlier one, so a step can revise its intended output before committing.

pub fn stage_json<T: Serialize>( &mut self, path: impl Into<PathBuf>, value: &T, ) -> Result<&mut Self>

Stage value serialized as pretty JSON (with trailing newline).

pub fn preview(&self) -> Vec<&Path>

The paths that commit would write, in staging order. Writes nothing — this is the preview surface.

pub fn is_empty(&self) -> bool

True when nothing is staged.

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

Apply every staged write atomically.

On success all files are updated. On the first failure, every write that already landed is rolled back to its captured pre-commit state and the original error is returned (rollback failures are attached as context).

Trait Implementations

impl Debug for SetupTransaction

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

Formats the value using the given formatter.

impl Default for SetupTransaction

fn default() -> SetupTransaction

Returns the “default value” for a type.