RUST-1874 Add optional integration with serde_path_to_error
#488
Conversation
This file contains hidden or 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
| #[non_exhaustive] | ||
| WithPath { | ||
| /// The path to the error. | ||
| path: serde_path_to_error::Path, |
There was a problem hiding this comment.
I think we need to account for the risk of breaking changes in serde_path_to_error since we're exposing third-party API here. We could follow the -{version} name pattern that the other flags use; however, it seems like this crate has been pretty stable over the past five years so it's probably less likely that we'll need to support multiple versions of it. What do you think about just documenting this feature as "unstable" to make sure users know that any breaking changes to serde_path_to_error will affect their usage of it via this library?
isabelatkinson
approved these changes
Jul 30, 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.
RUST-1874
Using the wrapped [de]serialization does come with a small CPU cost and a less small memory cost, so I've made this an optional feature. The user-visible API for this is a new variant for the
ser::Errorandde::Errortypes that wraps an inner error along with a path, and corresponding pretty-printed error messages for those. I'd have preferred anErrorstruct carrier for metadata and anErrorKindenum here but I think this is a reasonable non-breaking solution.