refactor(filesystem): role-based public API and heap encapsulation#27
Merged
Conversation
- expose capability modules (memory, tuple, codec, cache, block, page) and rewrite the crate doc as a role map, so the API is navigable by what you're doing rather than a flat wall of types - add Heap::open (owns its block store + page cache internally) and default the block-store backend on Heap and its view types, so the storage engine works only with tuples and never names FileBlockStore/PageCache - add a crate-level README (role map + quickstart + layering) - doc accuracy: WAL -> journal in cache comments, fix a journal codec comment, rename a stale test variable, clarify the sstable shard-layout note
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Role-based public API + heap encapsulation
Makes
filesystemnavigable and tightens its surface, plus a doc-accuracy sweep.API: organized by what you're doing
pub(memory,tuple,codec,cache,block,page) and the crate doc is a role map — "execution engine →memory; storage engine →tuple; format owner →codec; the rest is plumbing." No more flat wall of 25 root types.Encapsulation: the storage engine works only with tuples
Heap::open(dir, frames)builds and owns itsBlockStore+PageCacheinternally (absorbsstrata-store'sopen_heap).Heapand its view types (TupleRef/TupleView/PageTuples/TupleMut) default their block-store backend, sostrata-storewritesHeap/TupleRefand no longer namesFileBlockStoreorPageCacheanywhere. The plumbing is hidden behind the constructor; tuning hooks can be added later.Docs
WAL→journalin two cache comments, a journal codec comment, a stalefrom_pagertest variable, and the sstable shard-layout note.Workspace builds, clippy
-D warningsclean, all tests green.🤖 Generated with Claude Code