Skip to content

Commit 0c7da43

Browse files
committed
added a quick short README
1 parent 07f0020 commit 0c7da43

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

diskann-record/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# DiskANN Record
2+
3+
This crate provides a small framework for persisting structured Rust values as a
4+
manifest (can be serialized to JSON) plus a set of side-car binary artifacts, and
5+
reloading them later. It is can be used by `diskann` providers and indexes to
6+
implement durable, consistent and backward-compatible checkpoints.
7+
8+
Types describe how they map to a versioned record by implementing the `save::Save` and
9+
`load::Load` traits; the `save_fields!` and `load_fields!` macros handle the
10+
field-by-field plumbing for plain structs. Every record carries a `Version` so loaders
11+
can detect schema changes and either upgrade or fall back through a probing chain.
12+
13+
The goal is to allow crates like `diskann` to checkpoint their state without depending on
14+
a particular serialization backend. This crate has minimal dependencies by design.

0 commit comments

Comments
 (0)