about summary refs log tree commit diff
path: root/compiler/rustc_error_codes/src
diff options
context:
space:
mode:
authorsireliah <sajuukk@gmail.com>2021-10-10 14:58:12 +0200
committersireliah <sajuukk@gmail.com>2021-10-11 21:48:35 +0200
commit0fde6f672f91333f79c867ed9daee7350e4ec382 (patch)
tree2f7604dced286365230b2049740104d84e3473b6 /compiler/rustc_error_codes/src
parent14aae67bbc53eb248ee85eace8f648bd69e43c2a (diff)
downloadrust-0fde6f672f91333f79c867ed9daee7350e4ec382.tar.gz
rust-0fde6f672f91333f79c867ed9daee7350e4ec382.zip
Clarify the error descriptions
Diffstat (limited to 'compiler/rustc_error_codes/src')
-rw-r--r--compiler/rustc_error_codes/src/error_codes/E0482.md39
1 files changed, 22 insertions, 17 deletions
diff --git a/compiler/rustc_error_codes/src/error_codes/E0482.md b/compiler/rustc_error_codes/src/error_codes/E0482.md
index 5ae754b8252..58ebf43cc98 100644
--- a/compiler/rustc_error_codes/src/error_codes/E0482.md
+++ b/compiler/rustc_error_codes/src/error_codes/E0482.md
@@ -1,50 +1,50 @@
-A lifetime of return value does not outlive the function call.
+A lifetime of a returned value does not outlive the function call.
 
 Erroneous code example:
 
 ```compile_fail,E0482
 fn prefix<'a>(
     words: impl Iterator<Item = &'a str>
-) -> impl Iterator<Item = String> {
+) -> impl Iterator<Item = String> { // error!
     words.map(|v| format!("foo-{}", v))
 }
 ```
 
-To fix this error, make the lifetime of the returned value explicit.
+To fix this error, make the lifetime of the returned value explicit:
 
 ```
 fn prefix<'a>(
     words: impl Iterator<Item = &'a str> + 'a
-) -> impl Iterator<Item = String> + 'a {
+) -> impl Iterator<Item = String> + 'a { // ok!
     words.map(|v| format!("foo-{}", v))
 }
 ```
 
-[`impl Trait`] feature in return type have implicit `'static` lifetime
-restriction and the type implementing the `Iterator` passed to the function
-lives just `'a`, so shorter time.
+The [`impl Trait`] feature in this example uses an implicit `'static` lifetime
+restriction in the returned type. However the type implementing the `Iterator`
+passed to the function lives just as long as `'a`, which is not long enough.
 
 The solution involves adding lifetime bound to both function argument and
 the return value to make sure that the values inside the iterator
 are not dropped when the function goes out of the scope.
 
-Alternative solution would be to guarantee that the `Item` references
+An alternative solution would be to guarantee that the `Item` references
 in the iterator are alive for the whole lifetime of the program.
 
 ```
 fn prefix(
     words: impl Iterator<Item = &'static str>
-) -> impl Iterator<Item = String> {
+) -> impl Iterator<Item = String> {  // ok!
     words.map(|v| format!("foo-{}", v))
 }
 ```
 
-Similar lifetime problem might arise when returning closures.
-
-Erroneous code example:
+A similar lifetime problem might arise when returning closures:
 
 ```compile_fail,E0482
-fn foo(x: &mut Vec<i32>) -> impl FnMut(&mut Vec<i32>) -> &[i32] {
+fn foo(
+    x: &mut Vec<i32>
+) -> impl FnMut(&mut Vec<i32>) -> &[i32] { // error!
     |y| {
         y.append(x);
         y
@@ -52,11 +52,13 @@ fn foo(x: &mut Vec<i32>) -> impl FnMut(&mut Vec<i32>) -> &[i32] {
 }
 ```
 
-Analogically, solution here is to use explicit return lifetime
+Analogically, a solution here is to use explicit return lifetime
 and move the ownership of the variable to the closure.
 
 ```
-fn foo<'a>(x: &'a mut Vec<i32>) -> impl FnMut(&mut Vec<i32>) -> &[i32] + 'a {
+fn foo<'a>(
+    x: &'a mut Vec<i32>
+) -> impl FnMut(&mut Vec<i32>) -> &[i32] + 'a { // ok!
     move |y| {
         y.append(x);
         y
@@ -64,5 +66,8 @@ fn foo<'a>(x: &'a mut Vec<i32>) -> impl FnMut(&mut Vec<i32>) -> &[i32] + 'a {
 }
 ```
 
-- [`impl Trait`]: https://doc.rust-lang.org/reference/types/impl-trait.html
-- [RFC 1951]: https://rust-lang.github.io/rfcs/1951-expand-impl-trait.html
+To better understand the lifetime treatment in the [`impl Trait`],
+please see the [RFC 1951].
+
+[`impl Trait`]: https://doc.rust-lang.org/reference/types/impl-trait.html
+[RFC 1951]: https://rust-lang.github.io/rfcs/1951-expand-impl-trait.html