Struct LockFile 

pub struct LockFile { /* private fields */ }

Lock file handle that automatically releases on Drop

Implementations

impl LockFile

pub fn acquire(state_dir: &Path, workspace_root: Option<&Path>) -> Result<Self>

Acquire a lock file in the specified state directory

This will fail if a lock already exists and is not stale. Use is_locked first to check, or use acquire_with_timeout for automatic stale lock handling.

Example

use shipper_core::lock::LockFile;
use std::path::Path;

let lock = LockFile::acquire(Path::new(".mylock"), None)?;

pub fn acquire_with_timeout( state_dir: &Path, workspace_root: Option<&Path>, timeout: Duration, ) -> Result<Self>

Acquire a lock, automatically removing stale locks older than timeout

Arguments

• state_dir - Directory to store the lock file
• workspace_root - Optional workspace root to hash for avoiding global lock collisions
• timeout - Age threshold for considering a lock stale

Example

use shipper_core::lock::LockFile;
use std::path::Path;
use std::time::Duration;

let lock = LockFile::acquire_with_timeout(
    Path::new(".mylock"),
    None,
    Duration::from_secs(3600)
)?;

pub fn release(&self) -> Result<()>

Release the lock file

This is normally called automatically when the lock is dropped, but can be called explicitly if needed.

pub fn set_plan_id(&self, plan_id: &str) -> Result<()>

Update the plan_id in the lock file

pub fn is_locked( state_dir: &Path, workspace_root: Option<&Path>, ) -> Result<bool>

Check if a lock file exists

pub fn read_lock_info( state_dir: &Path, workspace_root: Option<&Path>, ) -> Result<LockInfo>

Read the lock file information

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.