-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Arbitrary self types v2: shadowing semver break. #15117
Open
adetaylor
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
adetaylor:shadowing-breakage-doc
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+132
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading status checks…
Arbitrary self types v2: shadowing semver break.
This is a pre-existing risk of semver breakage for types implementing Deref<Target=T>. It's made more apparent by the arbitrary self types v2 change, and will now generate errors under some circumstances. This PR documents the existing risk and the new ways it can be triggered. If it's seen as desirable to document the existing risk before Arbitrary Self Types v2 is stabilized, we can split this commit up into two. One of the two code examples here is marked "skip" because it depends on the nightly feature which is under discussion for stabilization. Part of rust-lang/rust#44874 Stabilization PR rust-lang/rust#135881
commit 1f44f8e5bdbe6c78631afc817d2d2041393bf41c
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"must not" is too strong.
This is intentionally done and relied on in a number of cases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you agree with the statement if I say:
If you have a type which implements
Deref<Target=T>
for an arbitrary user-controlledT
, you must not add methods which may "shadow" methods inT
.I'm quite keen to give a precise hard rule because it will make it easier for the
cargo semver
folks, if nothing else.If you still think that's not a true statement, could you give examples of where this is intentionally done and is OK? Some of these cases will turn into hard errors when/if rust-lang/rust#135881 lands.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I appreciate the precision in the rule — indeed very helpful.
For
cargo-semver-checks
purposes, the use of "must not" vs a different verb doesn't matter too much. We'll implement the same lint either way, since the goal of the tool is to notify maintainers that something risky / worth a look has happened and not to tie their hands about it. There are legitimate situations where users may ship known-breaking changes in non-major releases, and that's fine. We look to prevent unknown-breaking changes from happening.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@obi1kenobi @workingjubilee I'd appreciate a little more advice here about how to resolve this concern.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm fine with whatever @adetaylor and @workingjubilee decide on. I thoroughly trust your judgment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As a possible path forward, in an effort to save everyone else's valuable time:
This uses factual tone ("the change is breaking") and defers "must/should" level decisions to maintainers' judgment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, on stable, you can already have the case of function "overloading" done via using the fact that inherent implementations override trait implementations, and an existing pattern in-use in the ecosystem is to have
Trait
and then haveSometimesShadows<T>
which hasand then for
SometimesShadows<T>
you deliberately "shadow" certain otherwise-deref'd-to functions, so that you have an API where you for various reasons deliberately arrange to sometimes call functions on eitherTrait
,T
, orSometimesShadows<T>
. Then usually you repeat this for multiple different possibleSometimesShadows<T>
s, where each instance of this wrapper represents something and the deliberate override happens in certain cases. Then you have some code that gets macro-expanded in a monomorphic fashion and is the "real" driver for all of this.This is a complicated abstraction, as you can tell, but I have seen it done, in particular to enable a sort of cross-language reflection scheme. And yes, it intentionally worked with what were potentially arbitrary user-provided
T
s.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically the underlying truth of the matter is:
People do what is sometimes the most bizarre stuff quite on purpose, and while some of these decisions indeed are "breaking changes", they're quite deliberate when they are designed this way. Indeed, simply skipping over "must not" or "should not" is probably enough. Just tell people "this is a major change, this is not, and if you want to make breaking changes? uh, enjoy that, I guess? no refunds?"