Renaming serialize/deserialize methods to serializeTo/serializeFrom and deserializeTo/deserializeFrom#3880
Merged
LeStarch merged 12 commits intonasa:develfrom Jul 24, 2025
Merged
Conversation
…ializeFrom and deserializeTo/deserializeFrom methods to indicate direction.
…xed some bugs in Serializable.
Contributor
Author
|
Looks like we'll have to go forward with our plan to implement the FPP changes in tandem with this one. There doesn't seem to be a good way to decouple here. |
There was a problem hiding this comment.
CodeQL found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
thomas-bc
reviewed
Jul 22, 2025
…ity fall-back logic to aid in FPP decoupling.
thomas-bc
requested changes
Jul 23, 2025
thomas-bc
reviewed
Jul 24, 2025
Collaborator
thomas-bc
left a comment
There was a problem hiding this comment.
Last few nits and question
Thanks a lot, this is great work!
thomas-bc
approved these changes
Jul 24, 2025
Collaborator
thomas-bc
left a comment
There was a problem hiding this comment.
Looks good to me! Thanks a lot
LeStarch
approved these changes
Jul 24, 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
3 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.
Change Description
This change is part of the #3599 suggestions for code consistency. It is primarily a set of function name changes to clarify the direction of serialization and deserialization. In general, F' we has two flavors of serialization methods:
<buffer>.serialize(<element>)<element>.serialize(<buffer>)These both mean that the element is being serialized to the buffer. Whereas the following two flavors of
deserializemethods mean that we are deserializing from the buffer to the element.<buffer>.deserialize(<element>)<element>.deserialize(<buffer>)To improve the understanding of the direction of the serialization/deserialization this change renames the functions to
serializeTo/serializeFromanddeserializeTo/deserializeFrom.Rationale
Improve readability of F' code to allow quicker assessment of serialization/deserialization direction.
Testing/Review Recommendations
Unit testing was updated with new function names and re-run, 100% passing.
Future Work
Will need to update FPP shortly afterwards to auto-code new function names.