edgevec 0.9.0

High-performance embedded vector database for Browser, Node, and Edge
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

//! Persistence module for EdgeVec.
//!
//! Handles file formats, serialization, recovery, and logging.

/// Storage chunking logic.
pub mod chunking;
/// WAL entry definitions.
pub mod entry;
/// File header definitions.
pub mod header;
/// Persistence reader.
pub mod reader;
/// Snapshot management.
pub mod snapshot;
/// Storage backend.
pub mod storage;
/// Write-Ahead Log implementation.
pub mod wal;
/// Persistence writer.
pub mod writer;

pub use chunking::{ChunkedWriter, MIN_CHUNK_SIZE};
pub use header::{
    FileHeader, Flags, HeaderError, MetadataHeaderError, MetadataSectionHeader, FORMAT_JSON,
    FORMAT_POSTCARD, MAGIC, METADATA_MAGIC, METADATA_VERSION, VERSION_MAJOR, VERSION_MINOR,
    VERSION_MINOR_MIN,
};
pub use reader::{read_file_header, read_index_header};
pub use snapshot::{read_snapshot, write_snapshot};
pub use storage::{MemoryBackend, StorageBackend};
pub use writer::write_empty_index;

use thiserror::Error;

/// Errors that can occur during persistence operations.
#[derive(Debug, Error)]
pub enum PersistenceError {
    /// I/O error.
    #[error("io error: {0}")]
    Io(#[from] std::io::Error),

    /// Buffer too small.
    #[error("buffer too small: expected {expected}, got {actual}")]
    BufferTooSmall {
        /// Expected size in bytes.
        expected: usize,
        /// Actual size in bytes.
        actual: usize,
    },

    /// Invalid magic number.
    #[error("invalid magic number: expected {expected:?}, got {actual:?}")]
    InvalidMagic {
        /// Expected magic bytes.
        expected: [u8; 4],
        /// Actual magic bytes.
        actual: [u8; 4],
    },

    /// Unsupported version.
    #[error("unsupported version: {0}.{1}")]
    UnsupportedVersion(u8, u8),

    /// Checksum mismatch.
    #[error("checksum mismatch: expected {expected:#x}, got {actual:#x}")]
    ChecksumMismatch {
        /// Expected CRC32.
        expected: u32,
        /// Actual CRC32.
        actual: u32,
    },

    /// Header error.
    #[error("header error: {0}")]
    Header(#[from] HeaderError),

    /// Corrupted data.
    #[error("corrupted data: {0}")]
    Corrupted(String),

    /// Unsupported operation.
    #[error("unsupported: {0}")]
    Unsupported(String),

    /// Component not initialized.
    #[error("not initialized")]
    NotInitialized,

    /// Truncated data (unexpected end of snapshot).
    #[error("truncated data: expected more bytes")]
    TruncatedData,

    /// Serialization error.
    #[error("serialization error: {0}")]
    SerializationError(String),

    /// Deserialization error.
    #[error("deserialization error: {0}")]
    DeserializationError(String),
}