noxu-txn 4.1.0

Transaction management and locking for Noxu DB
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

//! Transaction state enum.
//!

/// Transaction states.
///
///
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TxnState {
    /// Transaction is active and accepting operations.
    Open,
    /// Transaction must be aborted (due to a failure).
    MustAbort,
    /// Transaction has been committed.
    Committed,
    /// Transaction has been aborted.
    Aborted,
}

impl TxnState {
    /// Returns true if the transaction is open.
    pub fn is_open(&self) -> bool {
        *self == TxnState::Open
    }

    /// Returns true if the transaction is in a valid state for operations.
    pub fn is_valid(&self) -> bool {
        matches!(self, TxnState::Open | TxnState::MustAbort)
    }

    /// Returns true if the transaction has ended (committed or aborted).
    pub fn is_ended(&self) -> bool {
        matches!(self, TxnState::Committed | TxnState::Aborted)
    }
}

impl std::fmt::Display for TxnState {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            TxnState::Open => write!(f, "OPEN"),
            TxnState::MustAbort => write!(f, "MUST_ABORT"),
            TxnState::Committed => write!(f, "COMMITTED"),
            TxnState::Aborted => write!(f, "ABORTED"),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_state_predicates() {
        assert!(TxnState::Open.is_open());
        assert!(!TxnState::MustAbort.is_open());
        assert!(!TxnState::Committed.is_open());
        assert!(!TxnState::Aborted.is_open());

        assert!(TxnState::Open.is_valid());
        assert!(TxnState::MustAbort.is_valid());
        assert!(!TxnState::Committed.is_valid());
        assert!(!TxnState::Aborted.is_valid());

        assert!(!TxnState::Open.is_ended());
        assert!(!TxnState::MustAbort.is_ended());
        assert!(TxnState::Committed.is_ended());
        assert!(TxnState::Aborted.is_ended());
    }

    #[test]
    fn test_display() {
        assert_eq!(TxnState::Open.to_string(), "OPEN");
        assert_eq!(TxnState::MustAbort.to_string(), "MUST_ABORT");
        assert_eq!(TxnState::Committed.to_string(), "COMMITTED");
        assert_eq!(TxnState::Aborted.to_string(), "ABORTED");
    }
}