docs: capability layers, atomic writes, memfs limitations#12
Merged
Conversation
The README only described the original Write/Remove interfaces. Add the new RenameFS and SyncWriterFile capability interfaces, a Capability layers table that maps each capability to its interface and helper, and a worked atomicWrite example showing how the two new capabilities combine for crash-safe writes. Also call out the memfs behaviors that differ from osfs (Close-publishes-writes, Sync-is-noop, file-only Rename) so callers porting code between backends are not surprised.
mojatter
force-pushed
the
docs/readme-capabilities
branch
from
cd24233 to
4fcdd3d
Compare
2 tasks
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.
Summary
Part of v0.5.0 release prep.
Test plan