ffi: Return metadata position, size, and type from decode_preamble for upper layer to parse. - #122
Merged
Merged
Conversation
…r upper layer to parse.
haiqi96
reviewed
May 20, 2023
kirkrodrigues
requested changes
May 20, 2023
…to use size_checked_pointer_cast
kirkrodrigues
approved these changes
May 21, 2023
junhaoliao
pushed a commit
to junhaoliao/clp
that referenced
this pull request
May 17, 2026
…r upper layer to parse. (y-scope#122)
Open
3 tasks
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.
Description
The metadata in a preamble may be encoding in various formats (e.g. json) with sparse fields as needed by individual use cases. Performing the parsing and validation of this metadata in the ffi layer adds unnecessary complexity and constraints to the metadata as the ffi code must handle all use cases.
This PR changes
decode_preambleto return the position, size, and type tag of the metadata to the upper layer. This allows the user of the ffi decide how they should parse and validate the metadata. This change also unifiesdecode_preamblefor four and eight byte encoding, as there is no difference between their behaviour any more.Validation performed
Adjusted preamble decoding unit tests. All [ffi] tagged tests passing.