fjall 3.1.4

Log-structured, embeddable key-value storage engine
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

// Copyright (c) 2024-present, fjall-rs
// This source code is licensed under both the Apache 2.0 and MIT License
// (found in the LICENSE-* files in the repository)

use crate::keyspace::config::{DecodeConfig, EncodeConfig};
use byteorder::{ReadBytesExt, WriteBytesExt};

impl EncodeConfig for crate::config::FilterPolicy {
    fn encode(&self) -> crate::Slice {
        let mut v = vec![];

        // NOTE: Policies are limited to 255 entries
        #[expect(clippy::cast_possible_truncation)]
        #[expect(clippy::expect_used)]
        v.write_u8(self.len() as u8)
            .expect("cannot fail writing into a vec");

        for item in self.iter() {
            match item {
                crate::config::FilterPolicyEntry::None => {
                    v.write_u8(0).expect("cannot fail writing into a vec");
                }
                crate::config::FilterPolicyEntry::Bloom(bloom) => {
                    v.write_u8(1).expect("cannot fail writing into a vec");

                    match bloom {
                        crate::config::BloomConstructionPolicy::BitsPerKey(bits) => {
                            v.write_u8(0).expect("cannot fail writing into a vec");
                            v.write_f32::<byteorder::LittleEndian>(*bits)
                                .expect("cannot fail writing into a vec");
                        }
                        crate::config::BloomConstructionPolicy::FalsePositiveRate(fpr) => {
                            v.write_u8(1).expect("cannot fail writing into a vec");
                            v.write_f32::<byteorder::LittleEndian>(*fpr)
                                .expect("cannot fail writing into a vec");
                        }
                    }
                }
            }
        }

        v.into()
    }
}

impl DecodeConfig for crate::config::FilterPolicy {
    fn decode(mut bytes: &[u8]) -> crate::Result<Self> {
        let len = bytes.read_u8()?;

        let mut v = vec![];

        for _ in 0..len {
            let tag = bytes.read_u8()?;

            match tag {
                0 => {
                    v.push(crate::config::FilterPolicyEntry::None);
                }
                1 => {
                    let policy_type = bytes.read_u8()?;

                    let policy = match policy_type {
                        0 => {
                            let bits = bytes.read_f32::<byteorder::LittleEndian>()?;

                            crate::config::FilterPolicyEntry::Bloom(
                                crate::config::BloomConstructionPolicy::BitsPerKey(bits),
                            )
                        }
                        1 => {
                            let value = bytes.read_f32::<byteorder::LittleEndian>()?;

                            crate::config::FilterPolicyEntry::Bloom(
                                crate::config::BloomConstructionPolicy::FalsePositiveRate(value),
                            )
                        }
                        _ => {
                            panic!("unknown bloom filter policy type: {policy_type}");
                        }
                    };

                    v.push(policy);
                }
                _ => {
                    panic!("unknown filter policy tag: {tag}");
                }
            }
        }

        Ok(Self::new(v))
    }
}

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

    #[test]
    fn roundtrip_filter_policy() -> crate::Result<()> {
        let policy = crate::config::FilterPolicy::new([
            crate::config::FilterPolicyEntry::Bloom(
                crate::config::BloomConstructionPolicy::BitsPerKey(10.0),
            ),
            crate::config::FilterPolicyEntry::Bloom(
                crate::config::BloomConstructionPolicy::FalsePositiveRate(0.01),
            ),
            crate::config::FilterPolicyEntry::None,
        ]);

        let encoded = policy.encode();
        let decoded = crate::config::FilterPolicy::decode(&encoded)?;

        assert_eq!(policy, decoded);
        Ok(())
    }
}