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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
use std::error::Error as StdError;
use std::ffi::CStr;
use std::os::raw::c_char;
use std::{fmt, str};
use libc::c_int;
#[cfg(master3)]
use lmdb_master3_sys as ffi;
#[cfg(not(master3))]
use lmdb_master_sys as ffi;
/// An LMDB error kind.
#[derive(Debug, Copy, Clone, Eq, PartialEq)]
pub enum Error {
/// A key/data pair already exists.
///
/// May be also returned by append functions. Data passed
/// doesn't respect the database ordering.
KeyExist,
/// A key/data pair was not found (EOF).
NotFound,
/// Requested page not found - this usually indicates corruption.
PageNotFound,
/// Located page was wrong type.
Corrupted,
/// Update of meta page failed or environment had fatal error.
Panic,
/// Environment version mismatch.
VersionMismatch,
/// File is not a valid LMDB file.
Invalid,
/// Environment mapsize reached.
MapFull,
/// Environment maxdbs reached.
DbsFull,
/// Environment maxreaders reached.
ReadersFull,
/// Too many TLS keys in use - Windows only.
TlsFull,
/// Txn has too many dirty pages.
TxnFull,
/// Cursor stack too deep - internal error.
CursorFull,
/// Page has not enough space - internal error.
PageFull,
/// Database contents grew beyond environment mapsize.
MapResized,
/// Operation and DB incompatible, or DB type changed. This can mean:
/// - The operation expects an MDB_DUPSORT / MDB_DUPFIXED database.
/// - Opening a named DB when the unnamed DB has MDB_DUPSORT / MDB_INTEGERKEY.
/// - Accessing a data record as a database, or vice versa.
/// - The database was dropped and recreated with different flags.
Incompatible,
/// Invalid reuse of reader locktable slot.
BadRslot,
/// Transaction cannot recover - it must be aborted.
BadTxn,
/// Unsupported size of key/DB name/data, or wrong DUP_FIXED size.
///
/// Common causes of this error:
/// - You tried to store a zero-length key
/// - You tried to store a key longer than the max allowed key (511 bytes by default)
/// - You are using [DUP_SORT](crate::DatabaseFlags::DUP_SORT) and trying to store a
/// value longer than the max allowed key size (511 bytes by default)
///
/// In the last two cases you can enable the `longer-keys` feature to increase the max allowed key size.
BadValSize,
/// The specified DBI was changed unexpectedly.
BadDbi,
/// Unexpected problem - transaction should abort.
Problem,
/// Page checksum incorrect.
#[cfg(master3)]
BadChecksum,
/// Encryption/decryption failed.
#[cfg(master3)]
CryptoFail,
/// Environment encryption mismatch.
#[cfg(master3)]
EnvEncryption,
/// Other error.
Other(c_int),
}
impl Error {
/// Returns `true` if the given error is [`Error::NotFound`].
pub fn not_found(&self) -> bool {
*self == Error::NotFound
}
/// Converts a raw error code to an `Error`.
pub fn from_err_code(err_code: c_int) -> Error {
match err_code {
ffi::MDB_KEYEXIST => Error::KeyExist,
ffi::MDB_NOTFOUND => Error::NotFound,
ffi::MDB_PAGE_NOTFOUND => Error::PageNotFound,
ffi::MDB_CORRUPTED => Error::Corrupted,
ffi::MDB_PANIC => Error::Panic,
ffi::MDB_VERSION_MISMATCH => Error::VersionMismatch,
ffi::MDB_INVALID => Error::Invalid,
ffi::MDB_MAP_FULL => Error::MapFull,
ffi::MDB_DBS_FULL => Error::DbsFull,
ffi::MDB_READERS_FULL => Error::ReadersFull,
ffi::MDB_TLS_FULL => Error::TlsFull,
ffi::MDB_TXN_FULL => Error::TxnFull,
ffi::MDB_CURSOR_FULL => Error::CursorFull,
ffi::MDB_PAGE_FULL => Error::PageFull,
ffi::MDB_MAP_RESIZED => Error::MapResized,
ffi::MDB_INCOMPATIBLE => Error::Incompatible,
ffi::MDB_BAD_RSLOT => Error::BadRslot,
ffi::MDB_BAD_TXN => Error::BadTxn,
ffi::MDB_BAD_VALSIZE => Error::BadValSize,
ffi::MDB_BAD_DBI => Error::BadDbi,
ffi::MDB_PROBLEM => Error::Problem,
#[cfg(master3)]
ffi::MDB_BAD_CHECKSUM => Error::BadChecksum,
#[cfg(master3)]
ffi::MDB_CRYPTO_FAIL => Error::CryptoFail,
#[cfg(master3)]
ffi::MDB_ENV_ENCRYPTION => Error::EnvEncryption,
other => Error::Other(other),
}
}
/// Converts an `Error` to the raw error code.
#[allow(clippy::trivially_copy_pass_by_ref)]
pub fn to_err_code(&self) -> c_int {
match *self {
Error::KeyExist => ffi::MDB_KEYEXIST,
Error::NotFound => ffi::MDB_NOTFOUND,
Error::PageNotFound => ffi::MDB_PAGE_NOTFOUND,
Error::Corrupted => ffi::MDB_CORRUPTED,
Error::Panic => ffi::MDB_PANIC,
Error::VersionMismatch => ffi::MDB_VERSION_MISMATCH,
Error::Invalid => ffi::MDB_INVALID,
Error::MapFull => ffi::MDB_MAP_FULL,
Error::DbsFull => ffi::MDB_DBS_FULL,
Error::ReadersFull => ffi::MDB_READERS_FULL,
Error::TlsFull => ffi::MDB_TLS_FULL,
Error::TxnFull => ffi::MDB_TXN_FULL,
Error::CursorFull => ffi::MDB_CURSOR_FULL,
Error::PageFull => ffi::MDB_PAGE_FULL,
Error::MapResized => ffi::MDB_MAP_RESIZED,
Error::Incompatible => ffi::MDB_INCOMPATIBLE,
Error::BadRslot => ffi::MDB_BAD_RSLOT,
Error::BadTxn => ffi::MDB_BAD_TXN,
Error::BadValSize => ffi::MDB_BAD_VALSIZE,
Error::BadDbi => ffi::MDB_BAD_DBI,
Error::Problem => ffi::MDB_PROBLEM,
#[cfg(master3)]
Error::BadChecksum => ffi::MDB_BAD_CHECKSUM,
#[cfg(master3)]
Error::CryptoFail => ffi::MDB_CRYPTO_FAIL,
#[cfg(master3)]
Error::EnvEncryption => ffi::MDB_ENV_ENCRYPTION,
Error::Other(err_code) => err_code,
}
}
}
impl fmt::Display for Error {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
let description = unsafe {
// This is safe since the error messages returned from mdb_strerror are static.
let err: *const c_char = ffi::mdb_strerror(self.to_err_code()) as *const c_char;
str::from_utf8_unchecked(CStr::from_ptr(err).to_bytes())
};
fmt.write_str(description)
}
}
impl StdError for Error {}
pub fn mdb_result(err_code: c_int) -> Result<(), Error> {
if err_code == ffi::MDB_SUCCESS {
Ok(())
} else {
Err(Error::from_err_code(err_code))
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_description() {
assert_eq!("Permission denied", Error::from_err_code(13).to_string());
assert_eq!("MDB_NOTFOUND: No matching key/data pair found", Error::NotFound.to_string());
}
}