file_mutex 0.1.1

A file based mutex system
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

use serde::{Deserialize, Serialize};

/// Mutex Configuration, stores all fields needed to manipulate Mutex
/// Contains most methods for using mutex in functions
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Mutex {
    pub state: MutexState,
    pub path: String,
    pub timeout: u64,
}

/// MutexState Can be Locked or Open, this data is stored in file
#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum MutexState {
    Locked,
    Open,
}


#[derive(Debug)]
pub enum MutexError {
    /// file system errors
    File(std::io::Error),
    /// mutex state specific errors
    State(MutexExceptions),
    /// generic (stuff like utf8 or unhandled errors
    Generic(String),
}
#[derive(Debug)]
pub enum MutexExceptions {
    /// tried to lock mutex, but mutex was already locked
    AlreadyLocked,
    /// Could not read mutex state (invalid file)
    InvalidState,
}