Skip to content

feat: allow deprecated variants in the impls that stack_error generates - #52

Merged
rklaehn merged 3 commits into
mainfrom
Frando/allow-deprecated
Nov 9, 2026
Merged

rklaehn merged 3 commits into
mainfrom
Frando/allow-deprecated

Conversation

@Frando

@Frando Frando commented Jul 14, 2026 •

Copy link
Copy Markdown
Member

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

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.

@github-actions

github-actions Bot commented Jul 14, 2026 •

Copy link
Copy Markdown

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/n0-error/pr/52/docs/n0_error/

Last updated: 2026-07-14T10:38:44Z

@Frando
Frando requested review from a team and dignifiedquire July 15, 2026 11:29

@flub flub left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I've done this by hand I only apply the #[allow(deprecated)] on branch that is deprecated instead of the entire enum block. Is that worth doing here as well or is there no downside to allowing it on all branches?

Suppresses the deprecated lint in the generated impls, so enums can have
@rklaehn
rklaehn force-pushed the Frando/allow-deprecated branch from 30af282 to 98afee4 Compare November 6, 2026 09:37
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 commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

Rebased onto main. I dropped the anyhow lock bump because main already has 1.0.104. The conflicts with #61 and #68 were mechanical, and tests pass.

A suggestion: we may not need the option. The generated impls only touch the enum's own variants, so an unconditional #[allow(deprecated)] never hides a real warning. User code that uses a deprecated variant still warns. thiserror does exactly this, and serde adds the allow automatically when the item or a variant is #[deprecated]. Neither has an opt-in. #69 is the reduced version on top of this branch.

On @flub's question: allowing per match arm would work, but it would mean touching every arm generator and the From impls, for no benefit in generated code.

rklaehn added a commit that referenced this pull request Nov 6, 2026
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

- [x] Self-review.
- [x] Tests if relevant.
@rklaehn
rklaehn force-pushed the Frando/allow-deprecated branch from 1bc3284 to 98afee4 Compare November 6, 2026 10:02
@rklaehn

rklaehn commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

I think it is preferably to solve this without an additional option, see #70

## 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 rklaehn changed the title feat: add allow_deprecated option to stack_error feat: allow deprecated variants in the impls that stack_error generates Nov 9, 2026
@rklaehn
rklaehn merged commit e46ade3 into main Nov 9, 2026
@rklaehn
rklaehn deleted the Frando/allow-deprecated branch November 9, 2026 12:51
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.

4 participants