-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
SemVer: Add section on RPIT capturing #14849
Open
ehuss
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
ehuss:semver-rpit-capture
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.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -81,6 +81,7 @@ considered incompatible. | |
* [Minor: generalizing a type to use generics (with identical types)](#generic-generalize-identical) | ||
* [Major: generalizing a type to use generics (with possibly different types)](#generic-generalize-different) | ||
* [Minor: changing a generic type to a more generic type](#generic-more-generic) | ||
* [Major: capturing more generic parameters in RPIT](#generic-rpit-capture) | ||
* Functions | ||
* [Major: adding/removing function parameters](#fn-change-arity) | ||
* [Possibly-breaking: introducing a new function type parameter](#fn-generic-new) | ||
|
@@ -1616,6 +1617,47 @@ fn main() { | |
} | ||
``` | ||
|
||
### Major: capturing more generic parameters in RPIT {#generic-rpit-capture} | ||
|
||
It is a breaking change to capture additional generic parameters in an [RPIT] (return-position impl trait). | ||
|
||
```rust,ignore | ||
// MAJOR CHANGE | ||
|
||
/////////////////////////////////////////////////////////// | ||
// Before | ||
pub fn f<'a, 'b>(x: &'a str, y: &'b str) -> impl Iterator<Item = char> + use<'a> { | ||
x.chars() | ||
} | ||
|
||
/////////////////////////////////////////////////////////// | ||
// After | ||
pub fn f<'a, 'b>(x: &'a str, y: &'b str) -> impl Iterator<Item = char> + use<'a, 'b> { | ||
x.chars().chain(y.chars()) | ||
} | ||
|
||
/////////////////////////////////////////////////////////// | ||
// Example usage that will break. | ||
fn main() { | ||
let a = String::new(); | ||
let b = String::new(); | ||
let iter = updated_crate::f(&a, &b); | ||
drop(b); // Error: cannot move out of `b` because it is borrowed | ||
} | ||
``` | ||
|
||
Adding generic parameters to an RPIT places additional constraints on how the resulting type may be used. | ||
|
||
Note that there are implicit captures when the `use<>` syntax is not specified. In Rust 2021 and earlier editions, the lifetime parameters are only captured if they appear syntactically within a bound in the RPIT type signature. Starting in Rust 2024, all lifetime parameters are unconditionally captured. This means that starting in Rust 2024, the default is maximally compatible, requiring you to be explicit when you want to capture less, which is a SemVer commitment. | ||
|
||
See the [edition guide][rpit-capture-guide] and the [reference][rpit-reference] for more information on RPIT capturing. | ||
|
||
It is a minor change to capture fewer generic parameters in an RPIT. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I believe this might not be true for functions in non-sealed traits. If the trait's function definition changes the RPIT captures, I expect implementations of the trait have to be updated to match. |
||
|
||
[RPIT]: ../../reference/types/impl-trait.md#abstract-return-types | ||
[rpit-capture-guide]: ../../edition-guide/rust-2024/rpit-lifetime-capture.html | ||
[rpit-reference]: ../../reference/types/impl-trait.md#capturing | ||
|
||
### Major: adding/removing function parameters {#fn-change-arity} | ||
|
||
Changing the arity of a function is a breaking change. | ||
|
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.
A thought: would it be worth adding an example, or even just mentioning in a sentence or two that
use<>
syntax can also be used to capture type parameters, not just lifetimes? That wasn't immediately obvious to me when I first heard about this new language feature.