splinter-rs 0.12.2

A compressed bitmap format optimized for small, sparse sets of u32s with zero-copy querying.
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

use crc64fast_nvme::Digest;
use zerocopy::{
    ByteEq, ByteHash, FromBytes, Immutable, IntoBytes, KnownLayout, LittleEndian, U64, Unaligned,
};

use crate::codec::DecodeErr;

/// The last four bytes of an encoded Splinter version 2
pub const SPLINTER_V2_MAGIC: [u8; 4] = [0x59, 0x11, 0xA7, 0xE2];

#[derive(FromBytes, IntoBytes, Immutable, Unaligned, KnownLayout, ByteHash, ByteEq)]
#[repr(C)]
pub struct Footer {
    checksum: U64<LittleEndian>,
    magic: [u8; 4],
}

impl Footer {
    pub const SIZE: usize = std::mem::size_of::<Self>();

    pub fn from_checksum(checksum: u64) -> Self {
        Self {
            checksum: checksum.into(),
            magic: SPLINTER_V2_MAGIC,
        }
    }

    pub fn validate(&self, data: &[u8]) -> Result<(), DecodeErr> {
        if self.magic != SPLINTER_V2_MAGIC {
            return Err(DecodeErr::Magic);
        }

        let checksum = {
            let mut c = Digest::new();
            c.write(data);
            c.sum64()
        };
        if checksum != self.checksum.get() {
            return Err(DecodeErr::Checksum);
        }

        Ok(())
    }
}