hyphae-storage 0.1.0

Append-only durable local storage, recovery, snapshots, and backups for Hyphae.
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

// SPDX-License-Identifier: Apache-2.0

//! Durable log, recovery, snapshot, and materialized-index implementation.

mod backup;
mod data_directory;
mod engine;
mod index;
mod log;
mod manifest;
mod mutation;
mod snapshot;

pub use backup::{BackupError, BackupInfo, RestoreInfo, restore_backup, verify_backup};
pub use data_directory::{DataDirectory, DataDirectoryError};
pub use engine::{
    CompactionOutcome, CompactionReport, KvEntry, KvPage, MAX_SCAN_PAGE_ENTRIES, OpenedStorage,
    StorageEngine, StorageError, StorageRecoveryReport,
};
pub use index::MaterializedIndexError;
pub use log::{
    AppendOutcome, CommitReceipt, DurableLog, LogError, OpenedLog, RecoveredTransaction,
    RecoveryReport,
};
pub use manifest::ManifestError;
pub use mutation::{MAX_KEY_BYTES, Mutation, MutationError};
pub use snapshot::{
    SnapshotContents, SnapshotEntry, SnapshotError, SnapshotInfo, SnapshotReadLimits,
    load_snapshot, verify_snapshot,
};

#[cfg(test)]
mod test_support {
    use std::{fs, io, path::PathBuf};

    pub(crate) struct TestDirectory {
        path: PathBuf,
    }

    impl TestDirectory {
        pub(crate) fn new(name: &str) -> io::Result<Self> {
            let path = std::env::temp_dir().join(format!(
                "hyphae-{name}-{}-{}",
                std::process::id(),
                uuid::Uuid::now_v7()
            ));
            fs::create_dir_all(&path)?;
            Ok(Self { path })
        }

        pub(crate) fn path(&self) -> &std::path::Path {
            &self.path
        }
    }

    impl Drop for TestDirectory {
        fn drop(&mut self) {
            let _ignored = fs::remove_dir_all(&self.path);
        }
    }
}