Add RFC 5531 Record Marking Standard references to Frame type#495
Merged
leighmcculloch merged 2 commits intomainfrom Feb 19, 2026
Merged
Add RFC 5531 Record Marking Standard references to Frame type#495leighmcculloch merged 2 commits intomainfrom
leighmcculloch merged 2 commits intomainfrom
Conversation
Add a doc comment to the Frame struct and update the inline comment in read_xdr to reference the Record Marking Standard defined in RFC 5531 Section 11, clarifying the fragment header format.
There was a problem hiding this comment.
Pull request overview
Adds RFC 5531 Record Marking Standard references/terminology to the Frame type documentation and related inline comments, improving discoverability and aligning the implementation commentary with the specification.
Changes:
- Add a rustdoc comment on
Framedescribing RFC 5531 §11 fragment header layout and Stellar’s single-fragment-per-record convention. - Update the
ReadXdr::read_xdrinline comment to use RFC terminology (last-fragment flag, fragment header fields).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This was referenced Feb 12, 2026
sisuresh
approved these changes
Feb 19, 2026
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.
What
Add a rustdoc comment to the
Framestruct inxdr-generator/generator/header.rsdescribing the Record Marking Standard from RFC 5531 Section 11, including the 4-byte fragment header layout and Stellar's single-fragment-per-record convention. Update the inline comment inReadXdr::read_xdrforFrameto use the RFC's terminology (last-fragment flag instead of the informal "flag-bit" / "more frames" wording).Why
The
Frametype implements RFC 5531 record marking, but neither the doc comment (which was missing) nor the inline comment named the RFC or used its terminology. Adding the reference makes the code discoverable viacargo docand gives contributors a direct link to the specification the implementation follows.Related