Struct ProjectLock 

pub struct ProjectLock { /* private fields */ }

A file lock for project-level operations.

Provides cross-process synchronization for operations like resource installation. Uses OS-level file locking via the fs4 crate.

Lock File Location

Lock files are stored in {project_dir}/.agpm/.locks/{lock_name}.lock

Example

use agpm_cli::installer::project_lock::ProjectLock;
use std::path::Path;

let project_dir = Path::new("/path/to/project");

// Acquire resource lock for file writes
let _lock = ProjectLock::acquire(project_dir, "resource").await?;

// Perform file operations...
// Lock is automatically released when _lock goes out of scope

Implementations

impl ProjectLock

pub async fn acquire(project_dir: &Path, lock_name: &str) -> Result<Self>

Acquires an exclusive lock for a project operation.

Creates and acquires an exclusive file lock for the specified lock name. Uses non-blocking lock attempts with exponential backoff and timeout.

Lock File Management

1. Creates .agpm/.locks/ directory if needed
2. Creates {lock_name}.lock file
3. Acquires exclusive access via OS file locking
4. Keeps file handle open to maintain lock

Behavior

• Timeout: 30-second default (configurable via acquire_with_timeout)
• Non-blocking: try_lock_exclusive() in async retry loop
• Backoff: 10ms → 20ms → 40ms… up to 500ms max

Errors

• Permission denied creating lock directory
• Disk space exhausted
• Timeout acquiring lock

Platform Support

• Windows: Win32 LockFile API
• Unix: POSIX fcntl() locking

pub async fn acquire_with_timeout( project_dir: &Path, lock_name: &str, timeout: Duration, ) -> Result<Self>

Acquires an exclusive lock with a specified timeout.

Uses exponential backoff (10ms → 500ms) without blocking the async runtime.

Errors

Returns timeout error if lock cannot be acquired within the specified duration.

Trait Implementations

impl Debug for ProjectLock

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

Formats the value using the given formatter.

impl Drop for ProjectLock

fn drop(&mut self)

Executes the destructor for this type.