Struct PidFileLocking

pub struct PidFileLocking(/* private fields */);

Very simple AdvisoryPathMutex class

The goal of this struct is to signal other processes that a path is being used by another process exclusively.

This struct will self-heal if the process that locked the file is no longer running.

Implementations

impl PidFileLocking

pub fn new<X: AsRef<Path>, Y: AsRef<Path>>( filename: X, dir: Y, extension: &str, ) -> PidFileLocking

pub fn lsp<X: AsRef<Path>>(filename: X) -> PidFileLocking

Create a new PidFileLocking instance that is shared between the LSP and any other process that may want to update the file and needs to wait for the LSP to finish (like forc-fmt)

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

Removes the lock file if it is not locked or the process that locked it is no longer active

pub fn get_locker_pid(&self) -> Option<usize>

Returns the PID of the owner of the current lock. If the PID is not longer active the lock file will be removed

pub fn is_locked(&self) -> bool

Checks if the current path is owned by any other process. This will return false if there is no lock file or the current process is the owner of the lock file

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

Locks the given filepath if it is not already locked

pub fn cleanup_stale_files() -> Result<Vec<PathBuf>>

Cleans up all stale lock files in the .lsp-locks directory Returns a vector of paths that were cleaned up