filelock 0.5.0

Cross-platform file locking library for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

use filelock::FileLock;

#[test]
fn test_basic_lock_and_unlock() {
    let filename = "test_basic.lock";
    let mut lock = FileLock::new(filename);

    // Test manual unlock
    let guard = lock.lock().unwrap();
    guard.unlock().unwrap();

    // Test RAII-style unlock
    let _guard = lock.lock().unwrap();
    // Guard is automatically dropped when it goes out of scope
}

#[test]
fn test_raii_automatic_unlock() {
    let filename = "test_raii.lock";
    let mut lock = FileLock::new(filename);

    {
        let _guard = lock.lock().unwrap();
        // Lock is held within this scope
    }

    // Lock should be automatically released, we can acquire it again
    let _guard = lock.lock().unwrap();
}

#[test]
fn test_multiple_instances_same_file() {
    let filename = "test_instances.lock";
    let mut lock1 = FileLock::new(filename);
    let mut lock2 = FileLock::new(filename);

    // First instance acquires lock
    let guard1 = lock1.lock().unwrap();
    drop(guard1); // Release the lock

    // Second instance can now acquire the lock
    let _guard2 = lock2.lock().unwrap();
}

#[test]
fn test_lock_file_creation_and_cleanup() {
    let filename = "test_creation.lock";

    // Ensure the file doesn't exist initially
    let _ = std::fs::remove_file(filename);

    {
        let mut lock = FileLock::new(filename);
        let _guard = lock.lock().unwrap();

        // Verify the lock file exists while locked
        assert!(
            std::path::Path::new(filename).exists(),
            "Lock file should exist while locked"
        );
    } // Guard is dropped, lock is released

    // Verify the lock file is deleted after guard is dropped
    assert!(
        !std::path::Path::new(filename).exists(),
        "Lock file should be deleted after guard is dropped"
    );
}