fix!: prevent double printing of conversion errors #33
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
Fields named `source` are treated as magical by `thiserror` and, when
using `#[derive(Error)]` are assumed to contain a sub-error. When a
`DecodeError::Conversion` is then formatted by `miette`, the conversion
error message contained in `source` is then printed twice: once by the
`#[error("{}", source)]` tag on `DecodeError::Conversion`, then a second
time, implicitly, because `miette` believes that
`DecodeError::Conversion` contains an unprinted sub-error.
This change simply renames the `source` field of
`DecodeError::Conversion` to `error`, side-stepping `thiserror`s special
treatment of fields named `source`.
BREAKING CHANGE: renamed public field `source` to `error`
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.
Most of this is just the commit description, but here's a picture of the sort of diff this change produces on my end:
You can see that I used to get the same error message twice (all errors coming from
DecodeError::Conversionhave been doubled!), but now the second, duplicate source line is removed.Okay, then just the commit description:
Fields named
sourceare treated as magical bythiserrorand, when using#[derive(Error)]are assumed to contain a sub-error. When aDecodeError::Conversionis then formatted bymiette, the conversion error message contained insourceis then printed twice: once by the#[error("{}", source)]tag onDecodeError::Conversion, then a second time, implicitly, becausemiettebelieves thatDecodeError::Conversioncontains an unprinted sub-error.This change simply renames the
sourcefield ofDecodeError::Conversiontoerror, side-steppingthiserrors special treatment of fields namedsource.BREAKING CHANGE: renamed public field
sourcetoerror