lora-wal 0.10.1

Write-ahead log and replay engine for LoraDB.
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

//! Error types and the [`WroteCommit`] flag returned from
//! [`super::WalRecorder::commit`].

use thiserror::Error;

use crate::errors::WalError;

/// Whether [`super::WalRecorder::commit`] actually wrote a `TxCommit` to the
/// log. Read-only queries — those that never trigger
/// `MutationRecorder::record` — return [`WroteCommit::No`] so the host avoids
/// any WAL I/O just to record an empty transaction.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WroteCommit {
    /// A `TxBegin` and matching `TxCommit` were written through
    /// `Wal::commit_tx`; the configured flush policy has already run.
    Yes,
    /// No mutation events fired during the query, so neither `TxBegin`
    /// nor `TxCommit` was appended. Caller can skip `flush()` entirely.
    No,
}

impl WroteCommit {
    pub fn wrote(self) -> bool {
        matches!(self, Self::Yes)
    }
}

#[derive(Debug, Error)]
pub enum WalCommitError {
    #[error("WAL commit failed: {0}")]
    Commit(#[source] WalError),
    #[error("WAL flush failed: {0}")]
    Flush(#[source] WalError),
}

#[derive(Debug, Error)]
#[error("WAL poisoned: {reason}")]
pub struct WalPoisonError {
    pub(super) reason: String,
}

impl WalPoisonError {
    pub fn reason(&self) -> &str {
        &self.reason
    }
}

#[derive(Debug, Error)]
pub enum WalBufferedCommitError {
    #[error("WAL arm failed: {0}")]
    Arm(#[source] WalError),
    #[error("WAL poisoned: {0}")]
    Poisoned(String),
    #[error("WAL poisoned during commit replay: {0}")]
    ReplayPoisoned(String),
    #[error(transparent)]
    Commit(#[from] WalCommitError),
}