feat: properly encapsulate quick_protobuf::Error
#3894
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
These leak into the public API.
mxinden
reviewed
May 9, 2023
Comment on lines
-133
to
+132
| pub struct DecodeError(String); | ||
|
|
||
| impl From<quick_protobuf::Error> for DecodeError { | ||
| fn from(e: quick_protobuf::Error) -> Self { | ||
| Self(e.to_string()) | ||
| } | ||
| } | ||
|
|
||
| impl fmt::Display for DecodeError { | ||
| fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result { | ||
| write!(f, "{}", self.0) | ||
| } | ||
| } | ||
| #[error(transparent)] | ||
| pub struct DecodeError(quick_protobuf::Error); |
There was a problem hiding this comment.
I am confused. Isn't the constructor of DecodeError the same as a From<quick_protobuf::Error>? Asked in a different way, changing DecodeError(quic_protobuf::Error) to e.g. DecodeError(SomeNewType) a breaking change? (Where SomeNewType might as well be quic_protobuf just as a new version.)
There was a problem hiding this comment.
No, if the field is crate-private, you can't construct it from outside this crate. Trait impls are global and because From can be imported and used by anyone, anyone can call this implemented and thus depend on the underlying quick_protobuf version.
It is a very nasty situation.
mxinden
approved these changes
May 12, 2023
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.
Description
I noticed that we also still leak that dependency in several crates by providing a
Fromimpl so I've removed that one as well.Resolves #3534.
Notes & open questions
Change checklist