signet-libmdbx 0.5.0

Idiomatic and safe MDBX wrapper
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

use crate::tx::{
    TxPtrAccess,
    access::{RoGuard, RwUnsync},
};
use ffi::{MDBX_TXN_RDONLY, MDBX_TXN_READWRITE, MDBX_txn_flags_t};

mod private {
    pub trait Sealed {}
    impl Sealed for super::RO {}
    impl Sealed for super::RW {}
}

/// Marker type for read-only transactions.
#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub struct RO;

/// Marker type for read-write transactions.
#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub struct RW;

/// Marker trait for transaction kinds with associated inner type.
///
/// The `Inner` associated type determines how the transaction pointer is
/// stored:
/// - For [`RO`]: Either `RoInner` (Arc/Weak) with feature `read-tx-timeouts`,
///   or raw pointer without it
/// - For [`RW`]: Always raw pointer (direct ownership)
pub trait TransactionKind: private::Sealed + core::fmt::Debug + 'static {
    #[doc(hidden)]
    const OPEN_FLAGS: MDBX_txn_flags_t;

    /// Whether this is a read-only transaction.
    const IS_READ_ONLY: bool;

    /// The inner storage type for the transaction pointer.
    type Inner: TxPtrAccess;
}

impl TransactionKind for RO {
    const OPEN_FLAGS: MDBX_txn_flags_t = MDBX_TXN_RDONLY;
    const IS_READ_ONLY: bool = true;

    // Without timeouts, RO uses direct pointer like RW
    type Inner = RoGuard;
}

impl TransactionKind for RW {
    const OPEN_FLAGS: MDBX_txn_flags_t = MDBX_TXN_READWRITE;
    const IS_READ_ONLY: bool = false;

    type Inner = RwUnsync;
}