Support mapping Enums to Result type #3102
Open
+269
−3
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
jschwe
force-pushed
the
jschwender/result-enums
branch
from
44a7a8e to
5a10e24
Compare
Some enums, where the Ok variant is 0, can be mapped to a Rust Result, with a NonZero<NewType> enum representation. Future improvements could add a callback which allows customizing the name error enum.
jschwe
force-pushed
the
jschwender/result-enums
branch
from
5a10e24 to
2a2605e
Compare
jschwe
force-pushed
the
jschwender/result-enums
branch
from
2a2605e to
1464db3
Compare
There is a `no_run`, but not `no_build` doctest attribute, so we need to ignore it to prevent CI from failing in the msrv build.
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.
Some enums, where the Ok variant is 0, can be mapped to a Rust
Result<(), NonZero<NewType>>representation, where the enum newtype is generated without the Ok variant.This PR adds a new option for the user to select this new Result representation for the enum, which can make the generated APIs more ergonomic, when C functions use the result enum as their return type.
Additionally, a parse callback is added, which allows renaming the new error enum (which does not contain the Ok / 0 variant).
As discussed in the linked issue, since Rust currently doesn't allow arbitrary niches, this new enum mapping can only work with C result enums, where 0 is the Ok value. Other error enums are out of scope.
Closes #2980