Struct WorktreeLock 

pub struct WorktreeLock { /* private fields */ }

The held lock. Dropping it releases it; a panic or an early return therefore cannot leave the repository locked.

Implementations

impl WorktreeLock

pub fn path_for(git_common_dir: &Path) -> PathBuf

The lock file for a repository, given its common git directory.

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

Take the lock, waiting up to WAIT for another holder to finish.

The primitive is O_CREAT|O_EXCL, which is atomic on every filesystem this runs on: exactly one caller creates the file. A file older than STALE_AFTER is removed and the attempt repeats, so a killed process is recovered from without a person being asked to delete anything.

pub fn acquire_with(git_common_dir: &Path, wait: Duration) -> Result<Self>

The same, with the waiting time as an argument, so a test does not wait twenty seconds to prove that a held lock is held.

pub fn path(&self) -> &Path

The lock file, for a message.

Trait Implementations

impl Debug for WorktreeLock

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

Formats the value using the given formatter.

impl Drop for WorktreeLock

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.