A cross-platform library for simple advisory file locking in Rust.
Take a look at the Documentation for details!
The lock supports both exclusive and shared locking modes for a byte range
of an opened File object. Exclusively locking a portion of a file denies
all other processes both shared and exclusive access to the specified
region of the file. Shared locking a portion of a file denies all processes
exclusive access to the specified region of the file. The locked range does
not need to exist within the file, and the ranges may be used for any
arbitrary advisory locking protocol between processes.
The result of a [lock()], [try_lock()], or [lock_any()] is a
[FileGuard]. When dropped, this [FileGuard] will unlock the region of
the file currently held. Exclusive locks may be [.downgrade()]'ed to
either a shared lock cross platform.
On Unix systems fcntl is used to perform the locking, and on Windows, LockFileEx.
All generally available behavior is consistent across platforms. For platform-
specific behavior, traits may be used for the respective platform. For example,
on Windows, locks cannot be safely upgraded, whereas on Unix systems, this can
be done safely and atomically. To use this feature, the
[file_guard::os::unix::FileGuardExt] may useed, enabling the [.upgrade()]
and [.try_upgrade()] methods.
```rust use file_guard::Lock; use std::fs::OpenOptions;
let file = OpenOptions::new() .read(true) .write(true) .create(true) .open("example-lock")?;
let lock = file_guard::lock(&file, Lock::Exclusive, 0, 1)?; // the lock will be unlocked when it goes out of scope ```
You can store one or more locks in a struct:
```rust use file_guard::{FileGuard, Lock}; use std::fs::{File, OpenOptions};
let file = OpenOptions::new() .read(true) .write(true) .create(true) .open("example-lock")?;
struct Thing<'file> { a: FileGuard<&'file File>, b: FileGuard<&'file File>, }
let t = Thing { a: fileguard::lock(&file, Lock::Exclusive, 0, 1)?, b: fileguard::lock(&file, Lock::Shared, 1, 2)?, }; // both locks will be unlocked when t goes out of scope ```
Anything that can Deref to a File can be used with the [FileGuard].
This works with Rc<File>:
```rust use file_guard::{FileGuard, Lock}; use std::fs::{File, OpenOptions}; use std::rc::Rc;
let file = Rc::new( OpenOptions::new() .read(true) .write(true) .create(true) .open("example-lock")? );
struct Thing {
a: FileGuard
let t = Thing { a: fileguard::lock(file.clone(), Lock::Exclusive, 0, 1)?, b: fileguard::lock(file, Lock::Shared, 1, 2)?, }; // both locks will be unlocked and the file will be closed when t goes out of scope ```