#lock #lock-files #git #marker #resources #commit #version-control

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

#35 in #lock-files

Download history 109/week @ 2024-11-16 162/week @ 2024-11-23 124/week @ 2024-11-30 243/week @ 2024-12-07 195/week @ 2024-12-14 86/week @ 2024-12-21 109/week @ 2024-12-28 96/week @ 2025-01-04 110/week @ 2025-01-11 174/week @ 2025-01-18 127/week @ 2025-01-25 207/week @ 2025-02-01 246/week @ 2025-02-08 249/week @ 2025-02-15 192/week @ 2025-02-22 161/week @ 2025-03-01

899 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–12MB
~154K SLoC