Add generic decoding exception classes#248
Merged
Merged
Conversation
piksel
changed the title
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
1 participant
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 will add exceptions to be thrown when an invalid state is reached during decoding of input streams.
StreamDecodingException is the main exception that the others inherit from and provides a way to signal that the input stream cannot be decoded by the library, either because of some bug or (unintentional) incompability or because of corrupted input data.
This is currently being handled very inconsistently in the library and sometimes not at all, leading to infinite loops and unexpected behaviour.
If the error is because of unimplemented or unsupported behaviour in the library, StreamUnsupportedException should be used instead. It is basically just a
NotImplementedExceptionderived fromSharpZipBaseException.UnexpectedEndOfStreamException should be used to indicate when no actual problem with the input data was found but more data was needed to complete the decoding. This could be a useful differentiation for consumers.
ValueOutOfRangeException is just a helper for easier formatting of a common failure.
I certify that I own, and have sufficient rights to contribute, all source code and related material intended to be compiled or integrated with the source code for the SharpZipLib open source product (the "Contribution"). My Contribution is licensed under the MIT License.