#file #unix #windows #locking #fd

fd-lock

Advisory cross-platform lock on a file using a file descriptor to it

23 stable releases (3 major)

4.0.4 Mar 10, 2025
4.0.2 Dec 29, 2023
4.0.0 Jun 30, 2023
3.0.13 Jun 29, 2023
1.1.0 Jun 28, 2019

#4 in Windows APIs

Download history 191526/week @ 2025-01-09 178547/week @ 2025-01-16 180894/week @ 2025-01-23 197264/week @ 2025-01-30 208461/week @ 2025-02-06 179064/week @ 2025-02-13 195681/week @ 2025-02-20 196659/week @ 2025-02-27 200847/week @ 2025-03-06 214143/week @ 2025-03-13 223988/week @ 2025-03-20 227387/week @ 2025-03-27 236698/week @ 2025-04-03 241228/week @ 2025-04-10 256670/week @ 2025-04-17 231382/week @ 2025-04-24

1,007,484 downloads per month
Used in 449 crates (43 directly)

MIT/Apache

26KB
503 lines

fd-lock

crates.io version downloads docs.rs docs

Advisory cross-platform file locks using file descriptors. 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::io::prelude::*;
use std::fs::File;
use fd_lock::RwLock;

// Lock a file and write to it.
let mut f = RwLock::new(File::open("foo.txt")?);
write!(f.write()?, "chashu cat")?;

// A lock can also be held across multiple operations.
let mut f = f.write()?;
write!(f, "nori cat")?;
write!(f, "bird!")?;

Installation

$ cargo add fd-lock

Safety

This crate uses unsafe on Windows to interface with windows-sys. All invariants have been carefully checked, and are manually enforced.

Contributing

Want to join us? Check out our "Contributing" guide and take a look at some of these issues:

References

License

MIT OR Apache-2.0

Dependencies

~2–11MB
~144K SLoC