pub struct DirLock { /* private fields */ }Expand description
An advisory exclusive lock on a ForgeDB data directory.
Holds an open File to <root>/.forgedb.lock with an OS-level exclusive
advisory lock (via fs2::FileExt::try_lock_exclusive). The lock is
released automatically when this value is dropped (the File closes, which
the OS uses to release the advisory lock).
§Acquiring
use forgedb_storage_native::DirLock;
use std::path::Path;
let lock = DirLock::acquire(Path::new("./data"))?;
// lock is held for the lifetime of the value
drop(lock); // released here§Conflicts
If another process already holds the lock, acquire
returns Err with kind() == io::ErrorKind::WouldBlock. The caller
should print a human-readable message and exit:
use forgedb_storage_native::DirLock;
use std::path::Path;
match DirLock::acquire(Path::new("./data")) {
Ok(lock) => { /* proceed */ }
Err(e) if e.kind() == std::io::ErrorKind::WouldBlock => {
eprintln!("error: another ForgeDB writer already has this data directory open");
std::process::exit(1);
}
Err(e) => return Err(e),
}Implementations§
Source§impl DirLock
impl DirLock
Sourcepub fn acquire(root: &Path) -> Result<DirLock, Error>
pub fn acquire(root: &Path) -> Result<DirLock, Error>
Try to acquire an exclusive advisory lock on <root>/.forgedb.lock,
creating the file (and any missing parent directories) if needed.
Returns Ok(DirLock) on success. If another process already holds the
lock, returns Err with kind() == io::ErrorKind::WouldBlock so the
caller can print a clear “another writer already has this data dir open”
message and exit.
§Errors
WouldBlock— another process already holds the exclusive lock.- Any other
io::Errorfrom creating the directory or opening the file.