Struct PlannedEdits 

pub(crate) struct PlannedEdits {
    root: RepositoryRoot,
    files: BTreeMap<RepositoryPath, Edit>,
}

A set of file snapshots and optional replacements from multiple targets.

Fields

root: RepositoryRoot

files: BTreeMap<RepositoryPath, Edit>

Implementations

impl PlannedEdits

pub(crate) fn new(root: &RepositoryRoot) -> Self

Start a transaction rooted at a repository.

pub(crate) fn add( &mut self, path: RepositoryPath, expected: Option<Vec<u8>>, replacement: Option<Vec<u8>>, ) -> Result<(), EditError>

Add one repository-relative file snapshot and an optional replacement.

expected = None means the file must not exist yet. replacement = None records a read-only snapshot so other target edits cannot invalidate it.

Adding the exact same snapshot and replacement for a path already present is a no-op, so an ecosystem adapter that recomputes the same shared edit for multiple units (for example, a Cargo workspace-wide version write shared by several packages) can contribute it once per unit without tracking which unit contributed it first.

Errors

Returns an error for a path that is a symlink or escapes the root, or for a path already contributed with different expected or replacement content.

pub(crate) fn compose<E: From<EditError>>( &mut self, path: RepositoryPath, current: &[u8], render: impl FnOnce(&[u8]) -> Result<Vec<u8>, E>, ) -> Result<(), E>

Rewrite the bytes planned for path, or plan an edit of current when the path has none yet.

render receives the bytes planned so far, so several contributors can change one file. The stale check stays on current.

Errors

Returns the error of render, or an edit error for a path that is a symlink or escapes the root, or that was planned from other bytes.

pub(crate) fn apply(&self) -> Result<(), EditError>

Check every source snapshot, then apply all replacements in one file transaction.

Errors

Returns an error if any path changed since planning or safe application fails.

pub(crate) fn changed_paths(&self) -> Vec<PathBuf>

Return repository-relative paths that this transaction will write.

Trait Implementations

impl Clone for PlannedEdits

fn clone(&self) -> PlannedEdits

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PlannedEdits

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

Formats the value using the given formatter.

impl Eq for PlannedEdits

impl PartialEq for PlannedEdits

fn eq(&self, other: &PlannedEdits) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for PlannedEdits