Make XLSError a sub-type of XlsException #1
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
Although we can map the original constructors of `XlsException` to the `XLSError` enum, various functions throw either of them. We make `XLSError` a sub-type of `XlsException` via an extra constructor so that the user only has to worry about catching one Exception type.
| @@ -129,13 +129,15 @@ CCALL(xls_cell_hidden, XLSCell -> IO Int8 -- Int8) | |||
| data XlsException = | |||
| XlsFileNotFound String | |||
| | XlsParseError String | |||
| | Libxls XLSError | |||
There was a problem hiding this comment.
The two cases of XLSError are already represented in XlsException. We can add the other cases as well, something like this:
data XlsException =
XlsFileNotFound String
| XlsParseError String
| XlsSeekError String
| XlsReadError String
| XlsMallocError String
And just translate XLSError to XlsException, and then do not export XLSError.
| -- | Experimental: This function uses the @xls_open_buffer@ function of libxls. | ||
| decodeXlsByteString' :: ByteString -> IO (Either XLSError [[[Cell]]]) | ||
| -- | Alternative to 'decodeXlsByteString': | ||
| -- This function uses the @xls_open_buffer@ function of libxls. |
There was a problem hiding this comment.
This is hard to understand for users of the library. We can instead say something like:
"This function does not use a temporary file unlike decodeXlsByteString".
BTW, why don't we just use solely this API and remove the other one? Is this not reliable?
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.
Although we can map the original constructors of
XlsExceptionto theXLSErrorenum, various functions throw either of them. We makeXLSErrora sub-type ofXlsExceptionvia an extra constructor so that the user only has to worry about catching one Exception type.