ipc-lock 0.1.4

Cross-process named locks using std::fs::File::lock() on Unix and CreateMutexW on Windows
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

//! Platform-specific OS locking primitives.
//!
//! Each platform module exposes a single type:
//!
//! ```text
//! pub(crate) struct OsLock { … }
//! impl OsLock {
//!     fn lock(&self) -> io::Result<LockAcquisition>
//!     fn try_lock(&self) -> io::Result<LockAcquisition>   // Err(WouldBlock) when held
//!     fn unlock(&self) -> io::Result<()>
//! }
//! ```

/// Result of acquiring the OS-level lock.
///
/// On Windows a named mutex may be abandoned when the previous owner terminates
/// without releasing it; on Unix this situation does not exist.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum LockAcquisition {
    /// Acquired normally.
    Normal,
    /// Acquired from an abandoned owner (Windows only).
    Abandoned,
}

#[cfg(unix)]
mod unix;
#[cfg(unix)]
pub(crate) use unix::OsLock;

#[cfg(windows)]
mod windows;
#[cfg(windows)]
pub(crate) use windows::OsLock;