tempest-core 0.0.2

Core utilities and primitives for TempestDB
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

use bincode::Options as BincodeOptions;

#[macro_use]
extern crate tracing;

#[macro_use]
extern crate derive_more;

pub mod encoding;
pub mod journal;
pub mod tempest_str;
pub mod utils;

#[cfg(any(test, feature = "testing"))]
pub mod test_utils;

/// The project wide used [`bincode`] encoding options.
// WARN: NEVER CHANGE THIS, OR ALL OF FILE DECODING WILL BREAK!
#[doc(hidden)]
pub fn bincode_options() -> impl BincodeOptions {
    bincode::options()
        // TODO: should we enfore this, or switch to varint encoding?
        .with_fixint_encoding() // no variable length ints, to ensure lower risk of errors
        .with_little_endian() // ensure consistency across platforms, enforcing little endian
        .allow_trailing_bytes() // important for decoding just parts of files, like in journals
}