feat: support #[deprecated] on enum variants #933
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
bkaestner
force-pushed
the
feature-deprecated-enum-variants
branch
from
4203db5
to
bfe9d44
Compare
While the #[deprecated] attribute was already used on structs, fns and
enums, it was not implemented for enum variants. The information about
enum variants is already available via `variant.body.annotations`, so
the support for the #[deprecated] attribute on enum-variant level is
more or less only another pair of entries within the `EnumConfig`.
This commit adds two new options within the `[enum]` settings:
- deprecated_variant, and
- deprecated_variant_with_notes
Both get active only on #[deprecated] variants, e.g.,
#[repr(u8)]
enum ApiLevel {
#[deprecated(note = "Legacy Support until 2025")]
L1 = 1,
#[deprecated]
L2 = 2,
L3 = 3,
L4 = 4,
}
For enums with struct variants, the current struct deprecation methods
are already working good enough (see tests/expecations/deprecated*).
bkaestner
force-pushed
the
feature-deprecated-enum-variants
branch
from
bfe9d44
to
be59618
Compare
emilio
approved these changes
Apr 14, 2024
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.
While the
#[deprecated]attribute was already used on structs, fns and enums, it was not implemented for enum variants. The information about enum variants is already available viavariant.body.annotations, so the support for the#[deprecated]attribute on enum-variant level is more or less only another pair of entries within theEnumConfig.This commit adds two new options within the
[enum]settings:deprecated_variant, anddeprecated_variant_with_notesBoth get active only on #[deprecated] variants, e.g.,
For enums with struct variants, the current struct deprecation methods are already working good enough (see
tests/expecations/deprecated*).This is my first PR on cbindgen, and I'm not entirely sure I correctly understood the test suite, and whether there need to be more tests for this feature.