Make public top-level TypedStreamDecoderError type - #16
Merged
Conversation
Overhaul documentation comments
There was a problem hiding this comment.
Pull request overview
Makes the typedstream decoder’s parsing errors a public, top-level type to avoid the prior nested Error that shadowed Swift.Error, and adds coverage for the user-facing error descriptions.
Changes:
- Introduce
publictop-levelTypedStreamDecoderErrorconforming toLocalizedError. - Update
TypedStreamDecoderto throwTypedStreamDecoderErrorinstead of the nested error type. - Add a unit test validating
TypedStreamDecoderError.errorDescriptionstrings.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| Tests/iMessageTests/DecodingTests.swift | Adds assertions for TypedStreamDecoderError.errorDescription formatting. |
| Sources/TypedStream/TypedStreamDecoder.swift | Replaces nested error with public TypedStreamDecoderError and refreshes decoder documentation/throws. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
Replaces internal, nested
Errortype that shadowedSwift.Error.