filelock 0.6.0

Cross-platform file locking library for Rust
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80

use std::fmt;
use std::io;

/// The operation that failed while managing a file lock.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[non_exhaustive]
pub enum ErrorOperation {
    /// Opening or creating the lock file.
    Open,
    /// Acquiring the file lock.
    Lock,
    /// Releasing the file lock.
    Unlock,
    /// Closing the lock file after use.
    Close,
}

impl fmt::Display for ErrorOperation {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(match self {
            Self::Open => "open lock file",
            Self::Lock => "acquire file lock",
            Self::Unlock => "release file lock",
            Self::Close => "close lock file",
        })
    }
}

/// An error produced while opening, acquiring, or releasing a file lock.
#[derive(Debug)]
pub struct Error {
    operation: ErrorOperation,
    source: io::Error,
}

impl Error {
    pub(crate) fn new(operation: ErrorOperation, source: io::Error) -> Self {
        Self { operation, source }
    }

    /// Returns the operation that failed.
    pub fn operation(&self) -> ErrorOperation {
        self.operation
    }

    /// Returns the portable category of the underlying operating-system error.
    pub fn kind(&self) -> io::ErrorKind {
        self.source.kind()
    }

    /// Returns the operating-system error code, when one is available.
    pub fn raw_os_error(&self) -> Option<i32> {
        self.source.raw_os_error()
    }

    /// Returns the underlying I/O error.
    pub fn io_error(&self) -> &io::Error {
        &self.source
    }

    /// Consumes this error and returns the underlying I/O error.
    pub fn into_io_error(self) -> io::Error {
        self.source
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "failed to {}: {}", self.operation, self.source)
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        Some(&self.source)
    }
}

/// A result returned by file-locking operations.
pub type Result<T> = std::result::Result<T, Error>;