Struct IndexLock 

pub struct IndexLock { /* private fields */ }

Exclusive .git/index.lock held for a mutating porcelain operation.

Acquire with Self::acquire before changing the working tree; persist the index with IndexHandle::commit_update or IndexHandle::write, then release on drop when uncommitted.

Implementations

impl IndexLock

pub fn acquire(index_path: &Path, config: Option<&ConfigSet>) -> Result<Self>

Create .git/index.lock exclusively, failing when another process holds it.

Errors

Returns Error::LockHeld (with the pid sidecar’s LockHolder when one was written) when index.lock already exists after the core.filesRefLockTimeout budget, or Error::Io for other filesystem failures.

Trait Implementations

impl Drop for IndexLock

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.