aboutsummaryrefslogtreecommitdiffstats
path: root/docs/store.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-16 16:15:04 +0000
committertv <tv@krebsco.de>2026-11-16 18:00:40 +0100
commit7bb467a013a9146620b633e3c3cdd21e3a48f80f (patch)
tree0fe86ef999faaf3547803aa73e391982a8ea3af8 /docs/store.md
parent40db32407a341f8fec2795ffb11821842e79334d (diff)
federation: the feature, and the store's fold
`federation`, a feature of its own, builds what `docs/federation.md` and `docs/store.md` design, stage by stage; without it continuum builds and behaves as it does. The aliases build with it, and `docs/development.md` says so. Its first part is the store's: an event's ID, the SHA-256 of its bytes written as 64 lower-case hex digits and read back only so, and the `Fold` trait as `docs/store.md` gives it. The trait reads a checkpoint's parts too, the heads it was built at and the events it keeps, which a node taking a pinned checkpoint needs; the design names it. Nothing uses either yet, but a test.
Diffstat (limited to 'docs/store.md')
-rw-r--r--docs/store.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/store.md b/docs/store.md
index 002b906..b766d41 100644
--- a/docs/store.md
+++ b/docs/store.md
@@ -113,6 +113,8 @@ pub trait Fold {
}
/// The checkpoint at `heads`, read as `at`: its bytes, and the events it keeps.
fn checkpoint(at: &Self::State, heads: &[Id]) -> (Vec<u8>, Vec<Id>);
+ /// The heads a checkpoint was built at, and the events it keeps.
+ fn parts(checkpoint: &[u8]) -> Option<(Vec<Id>, Vec<Id>)>;
/// The state a checkpoint reads as, with the events it keeps.
fn start(checkpoint: &[u8], kept: &[(Id, Vec<u8>)]) -> Result<Self::State, Refused>;
/// The root of a fork at `heads` of the stores reading as `at`, made by `spec`.