Make structure order part of the contract #465
Merged
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 change updates Smithy to make the order of structure members part of the contract of structures and unions. We previously sorted these members automatically. However, languages like C, C++, Rust and others require the order of structures to be consistent, and new fields added to the end to maintain ABI compatibility. This change adds that language to the spec, updates the semantic model to use insertion order, updates equality checks to ensure that members have the same order, and adds a diff evaluator to detect a violation.
kstich
approved these changes
Jun 12, 2020
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.
This change updates Smithy to make the order of structure members part
of the contract of structures and unions. We previously sorted these
members automatically. However, languages like C, C++, Rust and others
require the order of structures to be consistent, and new fields added
to the end to maintain ABI compatibility. This change adds that language
to the spec, updates the semantic model to use insertion order, updates
equality checks to ensure that members have the same order, and adds a
diff evaluator to detect a violation.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.