Skip to content

refactor: always allow deprecated in generated enum impls - #69

Merged
rklaehn merged 1 commit into
Frando/allow-deprecatedfrom
rklaehn/always-allow-deprecated
Nov 6, 2026
Merged

rklaehn merged 1 commit into
Frando/allow-deprecatedfrom
rklaehn/always-allow-deprecated

Conversation

@rklaehn

@rklaehn rklaehn commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Alternative to #52, based on its branch: instead of an allow_deprecated option, always put #[allow(deprecated)] on the generated enum impls.

The generated impls only match on and construct the user's own variants, so the allow never hides a real warning. Using a deprecated variant in user code still warns. thiserror does the same thing unconditionally, and serde does it automatically when it sees #[deprecated] on the item or a variant. Neither has an opt-in.

The test from #52 now runs without the option and also covers a deprecated from_sources variant. Without the change it fails with 5 deprecated errors.

Change checklist

  • Self-review.
  • Tests if relevant.

Drop the allow_deprecated option and emit #[allow(deprecated)] on the
generated enum impls unconditionally, like thiserror does. The impls only
touch the user's own variants, so there is nothing to opt into.
@rklaehn
rklaehn merged commit 1bc3284 into Frando/allow-deprecated Nov 6, 2026
@rklaehn
rklaehn deleted the rklaehn/always-allow-deprecated branch November 6, 2026 09:58
@rklaehn
rklaehn restored the rklaehn/always-allow-deprecated branch November 6, 2026 10:02
rklaehn added a commit that referenced this pull request Nov 9, 2026
## Description

Alternative to the unconditional allowance in #69, stacked on that
branch for a focused comparison. No explicit `allow_deprecated` macro
option.

Follow [Serde's
detection](https://github.com/serde-rs/serde/blob/master/serde_derive/src/deprecated.rs):
if the type or one of its enum variants has `#[deprecated]` or
`#[allow(deprecated)]`, allow deprecation in the generated impls.
Otherwise leave the lint unchanged.

This keeps ordinary enums working under `forbid(deprecated)` and
preserves warnings for deprecated functions used in their
`#[error("...", expression)]` formatting arguments. Deprecated types and
variants still derive without internal warnings; direct uses in user
code still warn.

The implementation adds 34 lines around derive expansion and removes the
unconditional allowances. A scoped anonymous const holds the generated
impls, avoiding an extra flag passed through each generator. This also
handles deprecated structs and whole enums. No new dependencies.

## Breaking Changes

Compared with #69, deprecated formatting helpers on otherwise ordinary
enums warn again. This preserves the behavior before the proposed
unconditional allowance.

## Notes & open questions

As with Serde, once detection triggers, the allowance covers all
generated impls, including user-provided formatting expressions inside
them. It is conditional, not scoped to individual expressions.

Validation: 26 unit tests and 4 doctests pass, including two
compile-fail regressions. `cargo fmt --check` passes. Clippy passes with
the existing `clippy::useless_format` warning at `src/tests.rs:110`
allowed; strict Clippy fails on that unchanged line.

## Change checklist

- [x] Self-review.
- [x] Documentation updates.
- [x] Tests, including deprecated types/variants, explicit allowances,
`forbid(deprecated)`, and retained user-code diagnostics.
- [x] All breaking changes documented.
rklaehn added a commit that referenced this pull request Nov 9, 2026
…es (#52)

## Description

The `stack_error` macro expands to impls that match on and construct
every enum variant, including deprecated ones. With
`#[deny(deprecated)]`, an enum with a `#[deprecated]` variant therefore
fails to compile at the `#[stack_error(..)]` call site.

`StackError` now allows the `deprecated` lint in its generated impls
when the type or one of its variants has `#[deprecated]` or
`#[allow(deprecated)]`. This needs no option. Serde handles deprecation
the same way.

- The allowance covers only the generated impls: they are wrapped in
`#[allow(deprecated)] const _: () = { ... };`. User code that constructs
a deprecated variant still warns.
- An enum without deprecation keeps the lint as it is, also in
user-provided formatting expressions such as `#[error("{}",
old_formatter())]`. Two `compile_fail` doctests in `tests/deprecated.md`
check this, together with the case above.
- Unit tests cover deprecated variants, deprecated enums and structs, an
`#[allow(deprecated)]` on the item or on a variant, and an enum without
deprecation under `#[forbid(deprecated)]`.

## Breaking Changes

None.

## Notes & open questions

The first version of this PR added an opt-in `allow_deprecated` option
to `stack_error`. It is gone; the allowance is now inferred from the
attributes (#69, #70).

On per-arm allowances: the allowance is scoped to the generated impls,
and those only touch the type's own variants, so allowing it on the
whole impl hides no warning in user code.

## Change checklist

- [x] Self-review.
- [x] Documentation updates following the [style
guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text),
if relevant.
- [x] Tests if relevant.
- [x] All breaking changes documented.

---------

Co-authored-by: Ruediger Klaehn <rklaehn@protonmail.com>
Co-authored-by: Rüdiger Klaehn <rklaehn@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant