Struct LockFile 

pub struct LockFile { /* private fields */ }

An exclusively created lock/temp file with atomic publication semantics.

Dropping an unpersisted guard closes the handle and removes the file, so failure paths never leave stale locks behind. Persisting renames the file over its target, which is atomic within a filesystem.

Implementations

impl LockFile

pub fn create(path: PathBuf) -> Result<Self>

Exclusively create the lock at exactly path; fails when it already exists (AlreadyExists kind, inspectable via GitError::io_kind).

pub fn acquire(target: &Path) -> Result<Self>

Exclusively create the sibling <target>.lock lock for target.

pub fn path(&self) -> &Path

The lock file’s own path.

pub fn target(&self) -> Option<&Path>

The publication target this lock was acquired for, when known.

pub fn file_mut(&mut self) -> Option<&mut File>

Mutable handle for streaming or filter-style writers.

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

Write the full payload through the lock handle.

pub fn sync( &mut self, policy: &Policy, component: FsyncComponents, ) -> Result<()>

Apply policy’s barrier for component to the lock handle. No-op when the policy excludes the component or the test switch disables syncing.

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

Publish onto the target remembered by Self::acquire: rename the lock over it, removing the lock file if the rename fails.

pub fn persist_into(self, target: &Path) -> Result<()>

Publish onto target: rename the lock over it. On rename failure the lock file is removed and the original error surfaces as GitError::Io, matching the pre-existing dance’s cleanup order.

pub fn persist_racy(self, target: &Path) -> Result<()>

Publish tolerating a concurrent writer that landed first: when the rename fails but target now exists, treat the write as won-by-other and succeed after removing our temp file. This matches the loose object store’s race handling, where two processes may materialize the same content-addressed object simultaneously.

pub fn keep(self) -> (PathBuf, Option<File>)

Disarm drop-cleanup and hand back the (path, handle) pair for mkstemp-style creators whose temporary file must survive the guard.

Trait Implementations

impl Debug for LockFile

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

Formats the value using the given formatter.

impl Drop for LockFile

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.