heed 0.23.0

A fully typed LMDB (mdb.master) wrapper with minimum overhead
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
81
82
83
84
85
86
87
88
89
90
91

use std::fmt;

/// An aborted or a committed value.
pub enum CommitOrAbort<T, A> {
    /// `Commit`ted transaction with the data inside.
    Commit(T),
    /// `Abort`ed transaction.
    Abort(A),
}

impl<T, A> CommitOrAbort<T, A> {
    /// Returns `Some` if the `CommitOrAbort` is a `Commit` value.
    #[inline]
    pub fn commit(self) -> Option<T> {
        match self {
            CommitOrAbort::Commit(data) => Some(data),
            CommitOrAbort::Abort(_) => None,
        }
    }

    /// Returns `Some` if the `CommitOrAbort` is an `Abort` value.
    #[inline]
    pub fn abort(self) -> Option<A> {
        match self {
            CommitOrAbort::Commit(_) => None,
            CommitOrAbort::Abort(data) => Some(data),
        }
    }

    /// Returns `true` if the option is a `Abort` value.
    #[inline]
    pub fn is_abort(&self) -> bool {
        matches!(self, CommitOrAbort::Abort(_))
    }

    /// Returns the contained `Commit`ted value, consuming the self value.
    ///
    /// # Panics
    ///
    /// Panics if the self value equals `Abort`.
    #[inline]
    #[track_caller]
    pub fn unwrap_commit(self) -> T
    where
        A: fmt::Debug,
    {
        match self {
            CommitOrAbort::Commit(data) => data,
            CommitOrAbort::Abort(abort) => {
                panic!("called `CommitOrAbort::unwrap_commit()` on an `Abort` value: {abort:?}")
            }
        }
    }

    /// Returns the contained `Abort`ted value, consuming the self value.
    ///
    /// # Panics
    ///
    /// Panics if the self value equals `Commit`.
    #[inline]
    #[track_caller]
    pub fn unwrap_abort(self) -> A
    where
        T: fmt::Debug,
    {
        match self {
            CommitOrAbort::Commit(data) => {
                panic!("called `CommitOrAbort::unwrap_abort()` on a `Commit` value: {data:?}")
            }
            CommitOrAbort::Abort(abort) => abort,
        }
    }
}

impl<T, E> From<Result<T, E>> for CommitOrAbort<T, E> {
    fn from(result: Result<T, E>) -> Self {
        match result {
            Ok(data) => CommitOrAbort::Commit(data),
            Err(error) => CommitOrAbort::Abort(error),
        }
    }
}

impl<T, E> From<CommitOrAbort<T, E>> for Result<T, E> {
    fn from(coa: CommitOrAbort<T, E>) -> Self {
        match coa {
            CommitOrAbort::Commit(data) => Ok(data),
            CommitOrAbort::Abort(abort) => Err(abort),
        }
    }
}