tempest-kv 0.0.2

Key-Value storage layer 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
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

use tempest_core::utils::{ByteSize, HexU64};
use zerocopy::{FromBytes, Immutable, IntoBytes, KnownLayout, LittleEndian, U32, U64};

use crate::sst::bloom::BloomFilterFooter;

/// Magic number stored in the footer of every `*.sst` file, used for file validation.
pub(crate) const SST_MAGICNUM: &[u8; 8] = b"TMPS_SST";

mod block;
mod bloom;
mod index;

pub mod error;
pub(crate) mod get;
pub(crate) mod iterator;
pub(crate) mod load;
pub(crate) mod write;

pub use error::*;
pub(crate) use get::*;
pub(crate) use iterator::*;
pub(crate) use load::*;
pub(crate) use write::*;

#[cfg(test)]
mod tests;

#[derive(derive_more::Debug, IntoBytes, FromBytes, KnownLayout, Immutable)]
#[repr(C)]
pub(crate) struct SstFooter {
    #[debug(ignore)]
    pub(crate) magic: [u8; 8],

    // -- bloom filter --
    #[debug("{:?}", HexU64(bloom_offset.get()))]
    pub(crate) bloom_offset: U64<LittleEndian>,
    #[debug("{:?}", ByteSize(bloom_size.get() as u64))]
    pub(crate) bloom_size: U32<LittleEndian>,
    pub(crate) bloom_footer: BloomFilterFooter,

    // -- block index --
    #[debug("{:?}", HexU64(index_offset.get()))]
    pub(crate) index_offset: U64<LittleEndian>,
    #[debug("{:?}", ByteSize(index_size.get() as u64))]
    pub(crate) index_size: U32<LittleEndian>,
}

impl SstFooter {
    pub(crate) fn new(
        bloom_offset: u64,
        bloom_size: u32,
        bloom_footer: BloomFilterFooter,
        index_offset: u64,
        index_size: u32,
    ) -> Self {
        Self {
            magic: *SST_MAGICNUM,
            bloom_offset: bloom_offset.into(),
            bloom_size: bloom_size.into(),
            bloom_footer,
            index_offset: index_offset.into(),
            index_size: index_size.into(),
        }
    }
}