coordinode-lsm-tree 5.2.1

Embedded LSM-tree storage engine: BuRR filters, zstd dictionary compression, MVCC, range tombstones, merge operators, K/V separation, AES-256-GCM at rest.
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

// Copyright (c) 2025-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::io::WriteBytesExt;
use crate::sfa::{checksum::Checksum, checksum_writer::ChecksummedWriter, toc::entry::TocEntry};
// `Write` is the std trait under `std` (so the concrete `ChecksummedWriter`'s
// `write_all` resolves from `std::io`) and the native trait under `no_std`.
#[cfg(not(feature = "std"))]
use crate::io::Write;
#[cfg(feature = "std")]
use std::io::Write;

pub const TOC_MAGIC: &[u8] = b"TOC!";

pub struct TocWriter;

impl TocWriter {
    pub fn write_into(
        mut writer: impl Write,
        entries: &[TocEntry],
    ) -> crate::sfa::Result<Checksum> {
        use crate::io::LE;

        log::trace!("Writing ToC");
        log::trace!("ToC: {entries:#?}");

        let mut writer = ChecksummedWriter::new(&mut writer);

        writer.write_all(TOC_MAGIC)?;
        writer.write_u32::<LE>(
            #[expect(
                clippy::expect_used,
                reason = "expect message documents the invariant: a TOC with >=2^32 entries is impossible by construction; panicking on the unreachable overflow is preferred over silent truncation"
            )]
            u32::try_from(entries.len())
                .expect("table of contents should not have 4 billion or more entries"),
        )?;

        for entry in entries {
            entry.write_into(&mut writer)?;
        }

        Ok(writer.checksum())
    }
}