errors: improve error APIs #130
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
Previously we had hand-rolled tests for errors. Unfortunately, once we move to mapping all errors to equivalent errnos for cffi, we will have to make this checking a little more complicated. Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
This is particularly important for errors like InvalidArgument that are generated within the capi code when a C caller provides invalid arguments. Being able to at least get an -EINVAL for _some_ programmatic way of matching on argument from C is useful. Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
As we plan to export ErrorKind, these kinds of internal errors should be made opaque since it seems incredibly unlikely that any real users would ever need to check them. Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
ErrorKind is safe for us to export (unlike ErrorImpl) because we can easily change the concrete types we use for our errors without causing downstream breakages. Most users almost certainly would prefer something that looks like std::io::ErrorKind anyway (which matches how we check for libpathrs errors inside libpathrs as well). Signed-off-by: Aleksa Sarai <cyphar@cyphar.com>
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 primarily contains two useful fixes related to our error APIs:
capi: error: map pure-Rust errors into equivalent errno values(capi: map libpathrs-generated errors to equivalent errno values #60)errors: document and export ErrorKind(errors: figure out if/how to expose ErrorKind #61)From the changelog:
ErrorKindis now exported, allowing you to programmatically handleerrors returned by libpathrs. This interface may change in the future (in
particular,
ErrorKind::OsErrormight change its representation oferrnovalues).
being passed by users) will now contain a
saved_errnovalue that makessense for the error type (so
ErrorKind::InvalidArgumentwill result in anEINVALvalue forsaved_errno). This will allow C users to have a nicertime handling errors programmatically.
Fixes #60
Fixes #61
Signed-off-by: Aleksa Sarai cyphar@cyphar.com