You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The library team still needs to formally approve these, which will likely happen soon.
35
-
<!-- TODO: hopefully this happens before we publish this -->
33
+
The tracking issue [can be found here](https://github.com/rust-lang/rust/issues/85684).
34
+
35
+
## Migration to Rust 2021
36
+
37
+
As a part of the 2021 edition a migration lint, `rust_2021_prelude_collisions`, has been added in order to aid in automatic migration of Rust 2018 codebases to Rust 2021.
38
+
39
+
In order to have `rustfix` migrate your code to be Rust 2021 Edition compatible, run:
40
+
41
+
```sh
42
+
cargo fix --edition
43
+
```
44
+
45
+
The lint detects cases where functions or methods are called that have the same name as the methods defined in one of the new prelude traits. In some cases, it may rewrite your calls in various ways to ensure that you continue to call the same function you did before.
46
+
47
+
If you'd like to migrate your code manually or better understand what `rustfix` is doing, below we've outlined the situations where a migration is needed along with a counter example of when it's not needed.
48
+
49
+
### Migration needed
50
+
51
+
#### Conflicting trait methods
52
+
53
+
When two traits that are in scope have the same method name, it is ambiguous which trait method should be used. For example:
54
+
55
+
```rust
56
+
traitMyTrait<A> {
57
+
// This name is the same as the `from_iter` method on the `FromIterator` trait from `std`.
58
+
fnfrom_iter(x:Option<A>);
59
+
}
60
+
61
+
impl<T> MyTrait<()> forVec<T> {
62
+
fnfrom_iter(_:Option<()>) {}
63
+
}
64
+
65
+
fnmain() {
66
+
// Vec<T> implements both `std::iter::FromIterator` and `MyTrait`
67
+
// If both traits are in scope (as would be the case in Rust 2021),
68
+
// then it becomes ambiguous which `from_iter` method to call
69
+
<Vec<i32>>::from_iter(None);
70
+
}
71
+
```
72
+
73
+
We can fix this by using fully qualified syntax:
74
+
75
+
```rust,ignore
76
+
fn main() {
77
+
// Now it is clear which trait method we're referring to
78
+
<Vec<i32> as MyTrait<i32>>::from_iter(None);
79
+
}
80
+
```
81
+
82
+
#### Inherent methods on `dyn Trait` objects
83
+
84
+
Some users invoke methods on a `dyn Trait` value where the method name overlaps with a new prelude trait:
85
+
86
+
```rust
87
+
modsubmodule {
88
+
pubtraitMyTrait {
89
+
// This has the same name as `TryInto::try_into`
90
+
fntry_into(&self) ->Result<u32, ()>;
91
+
}
92
+
}
93
+
94
+
// `MyTrait` isn't in scope here and can only be referred to through the path `submodule::MyTrait`
95
+
fnbar(f:Box<dynsubmodule::MyTrait>) {
96
+
// If `std::convert::TryInto` is in scope (as would be the case in Rust 2021),
97
+
// then it becomes ambiguous which `try_into` method to call
98
+
f.try_into();
99
+
}
100
+
```
101
+
102
+
Unlike with static dispatch methods, calling a trait method on a trait object does not require that the trait be in scope. The code above works
103
+
as long as there is no trait in scope with a conflicting method name. When the `TryInto` trait is in scope (which is the case in Rust 2021),
104
+
this causes an ambiguity. Should the call be to `MyTrait::try_into` or `std::convert::TryInto::try_into`?
105
+
106
+
In these cases, we can fix this by adding an additional dereferences or otherwise clarify the type of the method receiver. This ensures that
107
+
the `dyn Trait` method is chosen, versus the methods from the prelude trait. For example, turning `f.try_into()` above into `(&*f).try_into()`
108
+
ensures that we're calling `try_into` on the `dyn MyTrait` which can only refer to the `MyTrait::try_into` method.
109
+
110
+
### No migration needed
111
+
112
+
#### Inherent methods
113
+
114
+
Many types define their own inherent methods with the same name as a trait method. For instance, below the struct `MyStruct` implements `from_iter` which shares the same name with the method from the trait `FromIterator` found in the standard library:
115
+
116
+
```rust
117
+
usestd::iter::IntoIterator;
118
+
119
+
structMyStruct {
120
+
data:Vec<u32>
121
+
}
122
+
123
+
implMyStruct {
124
+
// This has the same name as `std::iter::FromIterator::from_iter`
Inherent methods always take precedent over trait methods so there's no need for any migration.
142
+
143
+
### Implementation Reference
144
+
145
+
The lint needs to take a couple of factors into account when determining whether or not introducing 2021 Edition to a codebase will cause a name resolution collision (thus breaking the code after changing edition). These factors include:
146
+
147
+
- Is the call a [fully-qualified call] or does it use [dot-call method syntax]?
148
+
- This will affect how the name is resolved due to auto-reference and auto-dereferencing on method call syntax. Manually dereferencing/referencing will allow specifying priority in the case of dot-call method syntax, while fully-qualified call requires specification of the type and the trait name in the method path (e.g. `<Type as Trait>::method`)
149
+
- Is this an [inherent method] or [a trait method]?
150
+
- Inherent methods that take `self` will take priority over `TryInto::try_into` as inherent methods take priority over trait methods, but inherent methods that take `&self` or `&mut self` won't take priority due to requiring a auto-reference (while `TryInto::try_into` does not, as it takes `self`)
151
+
- Is the origin of this method from `core`/`std`? (As the traits can't have a collision with themselves)
152
+
- Does the given type implement the trait it could have a collision against?
153
+
- Is the method being called via dynamic dispatch? (i.e. is the `self` type `dyn Trait`)
154
+
- If so, trait imports don't affect resolution, and no migration lint needs to occur
0 commit comments