2 unstable releases
0.2.0 | Jun 23, 2024 |
---|---|
0.1.1 | Jun 23, 2024 |
0.1.0 |
|
#509 in Filesystem
222 downloads per month
Used in rattler_repodata_gateway
33KB
671 lines
async-fd-lock
Advisory cross-platform file locks using file descriptors, with async support by off-loading blocking operations to newly spawned blocking tasks. Adapted from yoshuawuyts/fd-lock, which was adapted from mafintosh/fd-lock.
Note that advisory lock compliance is opt-in, and can freely be ignored by other parties. This means this crate should never be used for security purposes, but solely to coordinate file access.
Examples
Basic usage
use std::path::PathBuf;
use tokio::fs::File;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use async_fd_lock::{LockRead, LockWrite};
let dir = tempfile::tempdir().unwrap();
let path = dir.path().join("foo.txt");
// Lock it for writing.
{
let mut write_guard = File::options()
.create_new(true)
.write(true)
.truncate(true)
.open(&path).await?
.lock_write().await
.map_err(|(_, err)| err)?;
write_guard.write(b"bongo cat").await?;
}
// Lock it for reading.
{
let mut read_guard_1 = File::open(&path).await?.lock_read().await.map_err(|(_, err)| err)?;
let mut read_guard_2 = File::open(&path).await?.lock_read().await.map_err(|(_, err)| err)?;
let byte_1 = read_guard_1.read_u8().await?;
let byte_2 = read_guard_2.read_u8().await?;
}
Installation
$ cargo add async-fd-lock
Safety
This crate uses unsafe
on Windows to interface with windows-sys
. All
invariants have been carefully checked, and are manually enforced.
References
- LockFile function - WDC
- flock(2) - Linux Man Page
rustix::fs::flock
windows_sys::Win32::Storage::FileSystem::LockFile
License
MIT OR Apache-2.0
Dependencies
~2–14MB
~171K SLoC