fix(io): Framed won't stop reading if underlying IO returns Ok(0)#497
Merged
Conversation
Framed won't stop reading if underlying IO returns Ok(0)Fix/io eofFramed won't stop reading if underlying IO returns Ok(0)
Framed won't stop reading if underlying IO returns Ok(0)Framed won't stop reading if underlying IO returns Ok(0)
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the Framed module by restructuring internal state management, moving tests to a separate file, and improving documentation. The changes enhance encapsulation by making internal state transition methods private and introducing proper constructor methods.
- Wrapped read state in a new
Statestructure with aneoffield to properly track end-of-file - Introduced constructor methods (
new()andempty()) for both read and write states, improving API consistency - Moved test code from inline module to a dedicated test file in
compio-io/tests/framed.rs
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| compio-io/tests/framed.rs | New dedicated test file containing the framed functionality test previously in serde_json.rs |
| compio-io/src/framed/write.rs | Refactored state management with new constructors, made internal methods private, and reorganized code layout |
| compio-io/src/framed/read.rs | Introduced State wrapper struct with eof tracking and migrated from direct enum to inner/outer state pattern |
| compio-io/src/framed/mod.rs | Updated to use new state constructors and improved documentation with specific examples |
| compio-io/src/framed/codec/serde_json.rs | Removed inline test module (moved to dedicated test file) |
| compio-io/Cargo.toml | Added test configuration for the new framed test file with required features |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Berrysoft
approved these changes
Oct 29, 2025
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
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.
No description provided.