19 releases (11 major breaking)

14.0.0 May 22, 2024
13.1.1 Mar 14, 2024
13.1.0 Feb 6, 2024
12.0.1 Dec 30, 2023
3.0.2 Feb 17, 2023

#750 in Filesystem

Download history 114895/week @ 2024-06-03 112400/week @ 2024-06-10 115843/week @ 2024-06-17 104734/week @ 2024-06-24 103833/week @ 2024-07-01 105036/week @ 2024-07-08 108241/week @ 2024-07-15 115838/week @ 2024-07-22 114252/week @ 2024-07-29 109978/week @ 2024-08-05 109344/week @ 2024-08-12 107274/week @ 2024-08-19 108305/week @ 2024-08-26 116136/week @ 2024-09-02 118983/week @ 2024-09-09 108183/week @ 2024-09-16

461,376 downloads per month
Used in 242 crates (4 directly)

MIT/Apache

75KB
1.5K SLoC

Use lock-files in the way git does with auto-cleanup being the most notable feature.

  • writable lock files that can be committed to atomically replace the resource they lock
  • read-only markers that lock a resource without the intend to overwrite it
  • auto-removal of the lockfiles and intermediate directories on drop or on signal

lib.rs:

git-style registered lock files to make altering resources atomic.

In this model, reads are always atomic and can be performed directly while writes are facilitated by the locking mechanism implemented here. Locks are acquired atomically, then written to, to finally atomically overwrite the actual resource.

Lock files are wrapped gix-tempfile-handles and add the following:

  • consistent naming of lock files
  • block the thread (with timeout) or fail immediately if a lock cannot be obtained right away
  • commit lock files to atomically put them into the location of the originally locked file

Limitations

  • All limitations of gix-tempfile apply. A highlight of such a limitation is resource leakage which results in them being permanently locked unless there is user-intervention.
  • As the lock file is separate from the actual resource, locking is merely a convention rather than being enforced.

Dependencies

~3–12MB
~173K SLoC