fix: update wire protocol doc to reflect asymmetric CRC format #319
Conversation
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
The module-level documentation in wire.rs still described the old symmetric frame format without CRC headers. After the CRC32 checksum addition, the client→server direction now includes a 4-byte CRC prefix, while server→client retains the original format. Update the docs to accurately describe both directions. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Auto-Fix for PR #183
Issues Fixed
fuse-pipe/src/protocol/wire.rsstill described the old symmetric frame format (length + payload). After the CRC32 checksum addition in this PR, the client→server direction now uses[CRC][length][payload]while server→client retains[length][payload]. Updated docs to accurately describe both directions and explain why the format is asymmetric.Changes
fuse-pipe/src/protocol/wire.rsmodule doc comment to document the asymmetric wire format with separate sections for client→server (with CRC) and server→client (without CRC), plus a note explaining the rationale.Generated by Claude | Review Run