coordinode-lsm-tree 5.2.0

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
47
48
49
50
51
52
53
54
55
56

// 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::sfa::{
    toc::{Toc, reader::TocReader},
    trailer::reader::TrailerReader,
};
use std::io::{BufReader, Read, Seek};

/// Archive reader
pub struct Reader {
    toc: Toc,
}

impl Reader {
    /// Creates a new [`Reader`] from a file path.
    ///
    /// # Errors
    ///
    /// Returns error, if an IO error occurred.
    pub fn new(path: impl AsRef<std::path::Path>) -> crate::sfa::Result<Self> {
        let file = std::fs::File::open(path)?;
        let mut file = BufReader::with_capacity(4_096, file);
        let trailer = TrailerReader::from_reader(&mut file)?;
        let toc = TocReader::from_reader(
            &mut file,
            trailer.toc_pos,
            trailer.toc_len,
            trailer.toc_checksum,
        )?;
        Ok(Self { toc })
    }

    /// Creates a new [`Reader`] from a reader.
    ///
    /// # Errors
    ///
    /// Returns error, if an IO error occurred.
    pub fn from_reader<R: Read + Seek>(reader: &mut R) -> crate::sfa::Result<Self> {
        let trailer = TrailerReader::from_reader(reader)?;
        let toc = TocReader::from_reader(
            reader,
            trailer.toc_pos,
            trailer.toc_len,
            trailer.toc_checksum,
        )?;
        Ok(Self { toc })
    }

    /// Lists the table of contents.
    #[must_use]
    pub fn toc(&self) -> &Toc {
        &self.toc
    }
}