#lock #lock-file #git #marker #resources #commit #fail

deprecated git-lock

Please use gix-<thiscrate> instead (‘git’ -> ‘gix’)

16 releases (10 stable)

3.0.3 Feb 17, 2023
3.0.1 Dec 19, 2022
3.0.0 Nov 21, 2022
2.2.0 Nov 17, 2022
0.1.0 Jun 23, 2021

#33 in #fail

Download history 161/week @ 2024-05-22 168/week @ 2024-05-29 191/week @ 2024-06-05 322/week @ 2024-06-12 305/week @ 2024-06-19 329/week @ 2024-06-26 249/week @ 2024-07-03 250/week @ 2024-07-10 444/week @ 2024-07-17 579/week @ 2024-07-24 385/week @ 2024-07-31 445/week @ 2024-08-07 315/week @ 2024-08-14 308/week @ 2024-08-21 326/week @ 2024-08-28 265/week @ 2024-09-04

1,301 downloads per month
Used in 13 crates (4 directly)

MIT/Apache

61KB
1K 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 a locking mechanism implemented here.

Lock files mostly git-tempfile with its auto-cleanup and 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

  • As the lock file is separate from the actual resource, locking is merely a convention rather than being enforced.
  • The limitations of git-tempfile apply.

Dependencies

~3–11MB
~135K SLoC