~zethra/file-locker

ref: 9db95c64a8c036daa5238344b0c32e8e54922f40 file-locker/README.md -rw-r--r-- 1.7 KiB
9db95c64Sashanoraa Bump version to 1.1.0 7 months ago

#file-locker

File locking via POSIX advisory record locks (fork of file-lock)

This crate provides the facility to lock and unlock a file following the advisory record lock scheme as specified by UNIX IEEE Std 1003.1-2001 (POSIX.1) via fcntl().

This crate currently supports Linux and FreeBSD.

#USAGE

use file_lock::FileLock;
use std::io::prelude::*;
use std::io::Result;

fn main() -> Result<()> {
    let filelock = FileLock::new("myfile.txt")
                    .writeable(true)
                    .blocking(true)
                    .lock()?;

    filelock.file.write_all(b"Hello, World!")?;

    // Manually unlocking is optional as we unlock on Drop
    filelock.unlock();
}

#DOCUMENTATION

#SUPPORT

Please report any bugs at:

Or by email at:

#AUTHORS

Ben Goldberg <benaagoldberg@gmail.com>

Alfie John <alfie@alfie.wtf>

Sebastian Thiel <byronimo@gmail.com>

#Contribution

Contribution welcome!

Please send any patches to ~zethra/public-inbox@lists.sr.ht

If you need help sending a patch over email please see this guide

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, shall be licensed under the MIT license, without any additional terms or conditions.