raindb 1.0.0

A persistent key-value store based on an LSM tree implemented in Rust
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

// Copyright (c) 2021 Google LLC
//
// Use of this source code is governed by an MIT-style
// license that can be found in the LICENSE file or at
// https://opensource.org/licenses/MIT.

/*!
RainDB is a key-value store that is based on [LevelDB]. This project aims to be a learning tool for
those looking to take a deep dive on databases. It strives to uphold a high standard of code clarity
and to have extensive documentation on design and intentions of code. With regard to this, we have
configured the project such that `rustdoc` generates output even for private methods.

Please see the [RainDB repo] for more in-depth treatment on the design and operation of the
database.

[LevelDB]: https://github.com/google/leveldb
[RainDB repo]: https://github.com/nerdondon/raindb
*/

#![warn(missing_debug_implementations, missing_docs)]

pub mod db;
pub use db::DB;

pub mod errors;
pub use errors::{RainDBError, RainDBResult};

pub mod fs;

mod compaction;
mod config;
mod file_names;
mod logs;
mod memtable;
mod table_cache;
mod tables;
mod utils;
mod versioning;
mod writers;

mod batch;
pub use batch::{Batch, BatchElement};

pub mod filter_policy;
pub use filter_policy::{BloomFilterPolicy, FilterPolicy};

mod iterator;
pub use iterator::RainDbIterator;

mod key;
pub use key::Operation;

pub mod options;
pub use options::{DbOptions, ReadOptions, WriteOptions};

pub mod snapshots;
pub use snapshots::Snapshot;

pub use utils::cache::Cache;