karsher 0.8.2

karsher is a dumb cache written in rust
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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use std::{
    fs::{remove_file, File},
    io::{BufReader, BufWriter, Write},
    path::{Path, PathBuf},
};

use crate::prelude::debug;

#[derive(Debug, Clone)]
pub struct FileLock {
    _lock_p: PathBuf,
    inner_p: PathBuf,
}

impl FileLock {
    pub fn open<P: AsRef<Path>>(path: P) -> anyhow::Result<FileLock> {
        let _lock_p = path.as_ref().with_extension("lock");
        if Path::exists(&_lock_p) {
            return Err(anyhow::Error::msg("Could not acquire lock"));
        }
        // create files if not exist
        let _ = File::options().create(true).append(true).open(&path)?;
        let _ = File::create(&_lock_p)?;
        std::fs::copy(&path, &_lock_p)?;

        Ok(FileLock { _lock_p, inner_p: path.as_ref().to_path_buf() })
    }

    pub fn read(&self) -> anyhow::Result<BufReader<File>> {
        let _inner = File::options().read(true).open(&self.inner_p)?;
        let reader = BufReader::new(_inner);
        Ok(reader)
    }

    pub fn write(&self, buf: &[u8]) -> anyhow::Result<()> {
        let _lock = File::create(&self._lock_p)?;
        let mut writer = BufWriter::new(_lock);
        writer.write_all(buf)?;
        writer.flush()?;
        Ok(())
    }
}

impl Drop for FileLock {
    fn drop(&mut self) {
        debug!("remove lock for {}", self._lock_p.as_path().to_string_lossy());
        let swp = &self.inner_p.with_extension("swp");
        let _ = File::create(swp).unwrap();
        let _ = File::options()
            .write(true)
            .create(true)
            .open(&self.inner_p)
            .unwrap();

        std::fs::rename(&self.inner_p, swp).unwrap();

        std::fs::rename(&self._lock_p, &self.inner_p).unwrap();

        remove_file(swp).unwrap();
    }
}

#[cfg(test)]
mod test {
    use std::io::BufRead;

    use super::FileLock;

    #[test]
    fn test_lock() {
        let path = "/tmp/db.json";
        let file = FileLock::open(path).unwrap();
        let text = "\ni wanna wanna way";

        file.write(text.as_bytes()).unwrap();

        let mut reader = file.read().unwrap();
        let mut line = String::new();
        let len = reader.read_line(&mut line).unwrap();
        println!("First line is {len} bytes long");

        let open_file_twice = FileLock::open(path);

        match open_file_twice {
            Err(e) => assert_eq!(e.to_string(), "Could not acquire lock"),
            Ok(_) => (),
        }
    }
}