Refactor - Bincode 2 #47
Open
Conversation
This file contains 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
This allows other structs which wrap a fixed-length byte array to simply use it as a field, and not have to deal with any of the details of formatting or JSON hex (de)serialization.
this makes it clear which serialization format is being used where, as we are going to be changing this up soon
This will enable us to keep JSON serialization separate from the binary encoding, and also be much more explicit about the exact binary representation of objects.
This was referenced Aug 2, 2024
BHouwens
approved these changes
Aug 4, 2024
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.
Description
This PR depends on #43 (
serialize-utils).This updates the crate to use Bincode version 2 for object serialization. All object still use the Serde
Serialize/Deserializetraits; properly switching to Bincode 2'sEncode/Decodetraits will be handled in a subsequent PR.The advantage of Bincode 2 over Serde is that it makes it trivial to separate an object's binary representation from its human-readable form. The Serde API is poorly suited for binary formats, and makes it very difficult to implement an exact encoding scheme, while Bincode 2 uses a simpler byte stream-based interface. Additionally, the traits being separated allows us to easily implement only the required functions when overriding either the human-readable or binary encoding for a specific type.
Changelog
utils::serialize_utilsType of Change
Please mark the appropriate option by putting an "x" inside the brackets:
Checklist
Put an "x" in the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!
Screenshots (if applicable)
If the changes affect the UI or have visual effects, please provide screenshots or GIFs showcasing the changes.
Additional Context (if applicable)
Add any additional context or information about the changes that may be helpful in understanding the pull request.
Related Issues (if applicable)
If this pull request is related to any existing issues, please list them here.
Requested Reviewers
Mention any specific individuals or teams you would like to request a review from.