prolly-map 0.3.0

Content-addressed versioned map storage primitives.
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

//! Encoding types and default constants for Prolly Trees

use serde::{Deserialize, Serialize};

/// Initial (leaf) level from which the prolly tree is built
pub const INIT_LEVEL: u8 = 0;

/// Default seed for the hash function
pub const DEFAULT_HASH_SEED: u64 = 0;

/// Default minimum entries before considering chunk boundary
pub const DEFAULT_MIN_CHUNK_SIZE: usize = 4;

/// Default maximum number of key-value pairs in a node
pub const DEFAULT_MAX_CHUNK_SIZE: usize = 1024 * 1024;

/// Default chunking factor: 128 = ~0.78% boundary probability
pub const DEFAULT_CHUNKING_FACTOR: u32 = 128;

/// Encoding type for values
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize, Default)]
pub enum Encoding {
    #[default]
    Raw,
    Cbor,
    Json,
    Custom(String),
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_encoding_default() {
        let encoding = Encoding::default();
        assert_eq!(encoding, Encoding::Raw);
    }

    #[test]
    fn test_encoding_custom() {
        let encoding = Encoding::Custom("protobuf".to_string());
        assert_eq!(encoding, Encoding::Custom("protobuf".to_string()));
    }

    #[test]
    fn test_constants() {
        assert_eq!(INIT_LEVEL, 0);
        assert_eq!(DEFAULT_HASH_SEED, 0);
        assert_eq!(DEFAULT_MIN_CHUNK_SIZE, 4);
        assert_eq!(DEFAULT_MAX_CHUNK_SIZE, 1024 * 1024);
        assert_eq!(DEFAULT_CHUNKING_FACTOR, 128);
    }
}