[4.0] Make coding paths non-optional [DO NOT MERGE] #10729
Merged
Conversation
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
For the benefit of unkeyed containers, coding paths currently contain optional `CodingKey`s — unkeyed containers are allowed to report a `nil` key in a path. However, this is unhelpful for debugging purposes, or inspecting the coding path for context, since any unkeyed container simply reports `nil`, whether it’s at index 1 or 1000. Now all containers are required to report a non-optional CodingKey for their segment of the coding path, and coding paths are now exposed as `[CodingKey]`.
|
@swift-ci Please test macOS |
|
swiftlang/swift-corelibs-foundation#1091 |
|
Build failed |
|
swiftlang/swift-corelibs-foundation#1091 |
|
Build failed |
|
swiftlang/swift-corelibs-foundation#1091 |
|
Build failed |
|
swiftlang/swift-corelibs-foundation#1091 |
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.
What's in this pull request?
Cherry-picks #10728 to
swift-4.0-branch.Explanation: As laid out in a proposed update to SE-0166 and SE-0167, there are changes to unkeyed containers and coding paths that we want to introduce to the Codable API. This implements the remainder of those updates which had not yet been implemented:
For the benefit of unkeyed containers, coding paths currently contain optional
CodingKeys — unkeyed containers are allowed to report anilkey in a path. However, this is unhelpful for debugging purposes, or inspecting the coding path for context, since any unkeyed container simply reportsnil, whether it’s at index 1 or 1000Now all containers are required to report a non-optional CodingKey for their segment of the coding path, and coding paths are now exposed as
[CodingKey]To support this,
UnkeyedEncodingContainers now expose theircountandUnkeyedDecodingContainers expose theircurrentIndexScope: Affects writers of
Encoders/Decoders and consumers of the new Codable API.Radars:
Risk: Low
Testing: Updates existing unit tests to confirm expected behavior.
This PR should not be merged on its own. This must be merged simultaneously with #10728 and swiftlang/swift-corelibs-foundation#1091 to avoid breaking the build.