Add long form documentaiton explaining rust architecture#1583
Draft
Add long form documentaiton explaining rust architecture#1583
Conversation
Contributor-focused documentation explaining the internal architecture of the icechunk Rust library: - index.md: Overview and module map - architecture.md: Layered design, data flow, module dependencies - core-types.md: Snapshot, Manifest, content-addressable IDs - repository.md: Entry point, version specs, refs (branches/tags) - session.md: Transaction layer, ChangeSet enum, commit process - conflicts.md: Conflict detection and resolution - storage.md: Storage trait, AssetManager, virtual chunks - store.md: Zarr key-value interface Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
paraseba
approved these changes
Feb 2, 2026
| - **ChangeSet is checked first** for uncommitted writes in the current session | ||
| - **Inline chunks** return data directly from memory (no storage fetch) | ||
| - **Ref chunks** (uncommitted but already written) require a storage fetch | ||
| - **Committed chunks** are looked up via the base snapshot's manifests, with caching |
Collaborator
There was a problem hiding this comment.
delete "with caching" (it's not enabled by default)
|
|
||
| - **ChangeSet is checked first** for uncommitted writes in the current session | ||
| - **Inline chunks** return data directly from memory (no storage fetch) | ||
| - **Ref chunks** (uncommitted but already written) require a storage fetch |
Collaborator
There was a problem hiding this comment.
We call them Native chunks
| | `AssetManager` | Caches, `Storage` ref | `Session` | | ||
| | `Storage` | Backend connection | `AssetManager` | | ||
|
|
||
| ## Thread Safety |
Collaborator
There was a problem hiding this comment.
I'd delete this section, it can be obtained from the rust documentation and it's a bit confusing.
Collaborator
There was a problem hiding this comment.
What would be more useful is to know what object contains a reference to other objects, and if they use internal mutability or not. Does the session point to the repo? Does the store hold a Mutex to the Session? etc
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
2 participants
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.
opening early to review myself via github and rendered docs