okv 0.3.1

A versatile key-value storage library
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

#![doc = include_str!("../README.md")]

//! OKV - Okay Key-Value Storage
#![doc(test(
    no_crate_inject,
    attr(
        deny(warnings, rust_2018_idioms),
        allow(dead_code, unused_assignments, unused_variables)
    )
))]
#![warn(
    missing_docs,
    missing_debug_implementations,
    rust_2018_idioms,
    unreachable_pub
)]

#[doc(inline)]
pub use okv_core::db::Database;

#[doc(inline)]
pub use okv_core::db::DatabaseTransaction;

#[doc(inline)]
pub use okv_core::env::Env;

#[doc(inline)]
pub use okv_core::error::{DecodeError, EncodeError, Error};

#[doc(inline)]
/// Serialization types
pub use okv_core::types;

pub mod backend {
    //! Database backends
    //!
    //! * [`rocksdb`] - In-memory database backend (requires `memory` feature)
    //! * [`memory`] - RocksDB database backend (requires `rocksdb` feature). Based on <https://crates.io/crates/rocksdb>.
    // //! * [`sqlite`] - Sqlite database backend (requires `sqlite` feature). Based on <https://crates.io/crates/rusqlite>.

    #[cfg(feature = "rocksdb")]
    #[doc(inline)]
    pub use okv_rocksdb as rocksdb;

    #[cfg(feature = "memory")]
    #[doc(inline)]
    pub use okv_memory as memory;

    // TODO
    // #[cfg(feature = "sqlite")]
    // #[doc(inline)]
    // pub use okv_sqlite as sqlite;
}

#[doc(inline)]
pub use okv_core::traits::{
    DBCommon, DBCommonClear, DBCommonDelete, DBCommonIter, DBCommonIterPrefix, DBCommonRef,
    DBCommonRefBatch,
};