possum-db 0.2.0

concurrent disk-backed cache supporting efficient direct file I/O, transactions, and snapshots using file cloning and sparse files
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

use super::*;

cfg_if! {
    if #[cfg(unix)] {
        mod unix;
        pub use self::unix::*;
    } else if #[cfg(windows)] {
        mod windows;
        pub use self::windows::*;
    }
}

pub trait FileLocking {
    /// Returns Ok(false) if the lock could not be moved (you should assume the file is busted at
    /// this point).
    fn trim_exclusive_lock_left(&self, old_left: u64, new_left: u64) -> io::Result<bool>;
    fn lock_segment(&self, arg: FlockArg, len: Option<u64>, offset: u64) -> io::Result<bool>;
}

pub fn try_lock_file(file: &mut File, arg: FlockArg) -> anyhow::Result<bool> {
    file.lock_segment(arg, None, 0).map_err(Into::into)
}

#[cfg(test)]
mod tests {
    use tempfile::NamedTempFile;

    use super::*;
    use crate::test;

    #[test]
    fn open_locked_file() -> anyhow::Result<()> {
        let file1_named = NamedTempFile::new()?;
        let file1_ref = file1_named.as_file();
        let file_reopen = file1_named.reopen()?;
        assert!(file1_ref.lock_segment(LockExclusiveNonblock, None, 1)?);
        // Trying to exclusively lock from another file handle fails immediately.
        assert!(!file_reopen.lock_segment(LockExclusiveNonblock, None, 2)?);
        let file_reader = OpenOptions::new().read(true).open(file1_named.path())?;
        assert!(file_reader.lock_segment(LockSharedNonblock, Some(1), 0,)?);
        Ok(())
    }
}