flat_db 0.6.0

Flat file database
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

use crate::TableAction;
use rogue_logging::Failure;
use std::fs::remove_file;
use std::io;
use std::path::{Path, PathBuf};
use std::time::{Duration, Instant};
use tokio::fs::OpenOptions;
use tokio::time::sleep;
use tracing::trace;

const LOCK_ACQUIRE_SLEEP_MILLIS: u64 = 50;
const LOCK_ACQUIRE_TIMEOUT: u64 = 2;
const LOCK_FILE_EXTENSION: &str = "lock";

/// RAII guard that removes a lock file when dropped.
pub(crate) struct LockGuard {
    path: PathBuf,
}
impl Drop for LockGuard {
    fn drop(&mut self) {
        let _ = remove_file(&self.path);
    }
}

/// Acquire a lock
///
/// If the lock is already in use then wait
pub(crate) async fn acquire_lock(
    path: impl AsRef<Path>,
) -> Result<LockGuard, Failure<TableAction>> {
    let start = Instant::now();
    let timeout = Duration::from_secs(LOCK_ACQUIRE_TIMEOUT);
    let mut lock: PathBuf = path.as_ref().to_path_buf();
    lock.set_extension(LOCK_FILE_EXTENSION);
    loop {
        if OpenOptions::new()
            .write(true)
            .create_new(true)
            .open(&lock)
            .await
            .is_ok()
        {
            trace!(path = %lock.display(), "Lock acquired");
            return Ok(LockGuard { path: lock });
        }
        if start.elapsed() > timeout {
            return Err(Failure::new(
                TableAction::AcquireLock,
                io::Error::new(
                    io::ErrorKind::TimedOut,
                    "Exceeded timeout for acquiring lock",
                ),
            )
            .with_path(&lock));
        }
        trace!(path = %lock.display(), "Lock busy, waiting");
        sleep(Duration::from_millis(LOCK_ACQUIRE_SLEEP_MILLIS)).await;
    }
}