sled_overlay/
lib.rs

1/* This file is part of sled-overlay
2 *
3 * Copyright (C) 2023-2024 Dyne.org foundation
4 *
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU Affero General Public License as
7 * published by the Free Software Foundation, either version 3 of the
8 * License, or (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 * GNU Affero General Public License for more details.
14 *
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
17 */
18
19//! sled-overlay is a small crate that serves as tooling to have intermediate
20//! writes to some sled database. With it, we're able to write data into an
21//! in-memory cache, and only flush to the actual sled trees after we decide
22//! that everything in some batch was executed correctly.
23//! This gives some minimal infrastructure to be able to transparently have
24//! rollback-like functionality.
25
26pub use sled;
27
28pub mod tree;
29pub use tree::{
30    SledTreeOverlay, SledTreeOverlayIter, SledTreeOverlayState, SledTreeOverlayStateDiff,
31};
32
33pub mod database;
34pub use database::{SledDbOverlay, SledDbOverlayStateDiff};