Struct BranchCommitRefLock 

pub struct BranchCommitRefLock { /* private fields */ }

Loose branch ref lock held between CAS validation and the ref file commit.

Dropping without commit_branch_commit_ref_lock aborts the lock file.

Implementations

impl BranchCommitRefLock

pub fn acquire( git_dir: &Path, branch_ref: &str, expected_old: Option<ObjectId>, ) -> Result<Self>

Acquire the branch ref lock and verify expected_old before worktree mutations.

Errors

Same as update_branch_for_commit_with_config, except no reflogs or ref write occur yet.

pub fn write_reflogs( &mut self, git_dir: &Path, update: &BranchCommitRefUpdate<'_>, reflog_old: &ObjectId, config: &ConfigSet, ) -> Result<()>

Append branch and HEAD reflog entries while holding the lock from Self::acquire.

Intended to run before worktree checkout so reflog I/O failures do not leave the index or working tree ahead of HEAD.

Errors

Returns I/O or reflog failures; the ref lock is aborted and any branch reflog line written in this call is truncated.

pub fn finish_ref_commit( self, git_dir: &Path, update: &BranchCommitRefUpdate<'_>, ) -> Result<()>

Write the new OID into the held lock file and rename it over the branch ref.

Call after the worktree matches update.new_oid when splitting reflog work from checkout.

Errors

Returns I/O failures; the ref lock is aborted unless the rename succeeds.

pub fn commit( self, git_dir: &Path, update: &BranchCommitRefUpdate<'_>, reflog_old: &ObjectId, config: &ConfigSet, ) -> Result<()>

Write reflogs and commit the branch ref while holding the lock from Self::acquire.

Errors

Returns I/O or reflog failures; the lock is aborted unless the ref commit succeeds.

Trait Implementations

impl Drop for BranchCommitRefLock

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.