Skip to content
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

Add long description and test for E0311 #100747

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion compiler/rustc_error_codes/src/error_codes.rs
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ E0307: include_str!("./error_codes/E0307.md"),
E0308: include_str!("./error_codes/E0308.md"),
E0309: include_str!("./error_codes/E0309.md"),
E0310: include_str!("./error_codes/E0310.md"),
E0311: include_str!("./error_codes/E0311.md"),
E0312: include_str!("./error_codes/E0312.md"),
E0316: include_str!("./error_codes/E0316.md"),
E0317: include_str!("./error_codes/E0317.md"),
Expand Down Expand Up @@ -568,7 +569,6 @@ E0790: include_str!("./error_codes/E0790.md"),
// E0300, // unexpanded macro
// E0304, // expected signed integer constant
// E0305, // expected constant
E0311, // thing may not live long enough
E0313, // lifetime of borrowed pointer outlives lifetime of captured
// variable
// E0314, // closure outlives stack frame
Expand Down
49 changes: 49 additions & 0 deletions compiler/rustc_error_codes/src/error_codes/E0311.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
E0311 occurs when there is insufficient information for the rust compiler to
MatthewPeterKelly marked this conversation as resolved.
Show resolved Hide resolved
prove that some time has a long enough lifetime.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contributions! This explanation could be a bit confusing, I don't know how it should be reworded into, cc @compiler-errors any ideas?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point -- it would be great to have a better description here. I'm still pretty new to rust, so this was my initial attempt at reverse engineering why the fix worked.


Erroneous code example:

```compile_fail, E0311
MatthewPeterKelly marked this conversation as resolved.
Show resolved Hide resolved
use std::borrow::BorrowMut;

trait NestedBorrowMut<U, V> {
fn nested_borrow_mut(&mut self) -> &mut V;
}

impl<T, U, V> NestedBorrowMut<U, V> for T
where
T: BorrowMut<U>,
U: BorrowMut<V>, // missing lifetime specifier here --> compile fail
MatthewPeterKelly marked this conversation as resolved.
Show resolved Hide resolved
{
fn nested_borrow_mut(&mut self) -> &mut V {
self.borrow_mut().borrow_mut()
}
}
```

In this example we have a trait that borrows some inner data element of type V
from an outer type T, through an intermediate type U. The compiler is unable to
prove that the livetime of U is long enough to support the reference, so it
throws E0311. To fix the issue we can explicitly add lifetime specifiers to the
trait, which link the lifetimes of the various data types and allow the code
to compile.
MatthewPeterKelly marked this conversation as resolved.
Show resolved Hide resolved

Working implementation of the `NestedBorrowMut` trait:

```
use std::borrow::BorrowMut;

trait NestedBorrowMut<'a, U, V> {
fn nested_borrow_mut(& 'a mut self) -> &'a mut V;
}

impl<'a, T, U, V> NestedBorrowMut<'a, U, V> for T
where
T: BorrowMut<U>,
U: BorrowMut<V> + 'a,
MatthewPeterKelly marked this conversation as resolved.
Show resolved Hide resolved
{
fn nested_borrow_mut(&'a mut self) -> &'a mut V {
self.borrow_mut().borrow_mut()
}
}
```
18 changes: 18 additions & 0 deletions src/test/ui/error-codes/E0311.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
use std::borrow::BorrowMut;

trait NestedBorrowMut<U, V> {
fn nested_borrow_mut(&mut self) -> &mut V;
}

impl<T, U, V> NestedBorrowMut<U, V> for T
where
T: BorrowMut<U>,
U: BorrowMut<V>, // Error is caused by missing lifetime here
{
fn nested_borrow_mut(&mut self) -> &mut V {
let u_ref = self.borrow_mut(); //~ ERROR E0311
u_ref.borrow_mut() //~ ERROR E0311
}
}

fn main() {}
45 changes: 45 additions & 0 deletions src/test/ui/error-codes/E0311.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
error[E0311]: the parameter type `U` may not live long enough
--> $DIR/E0311.rs:13:21
|
LL | let u_ref = self.borrow_mut();
| ^^^^^^^^^^^^^^^^^
|
note: the parameter type `U` must be valid for the anonymous lifetime defined here...
--> $DIR/E0311.rs:12:26
|
LL | fn nested_borrow_mut(&mut self) -> &mut V {
| ^^^^^^^^^
note: ...so that the type `U` will meet its required lifetime bounds
--> $DIR/E0311.rs:13:21
|
LL | let u_ref = self.borrow_mut();
| ^^^^^^^^^^^^^^^^^
help: consider adding an explicit lifetime bound...
|
LL | U: BorrowMut<V> + 'a, // Error is caused by missing lifetime here
| ++++

error[E0311]: the parameter type `U` may not live long enough
--> $DIR/E0311.rs:14:9
|
LL | u_ref.borrow_mut()
| ^^^^^^^^^^^^^^^^^^
|
note: the parameter type `U` must be valid for the anonymous lifetime defined here...
--> $DIR/E0311.rs:12:26
|
LL | fn nested_borrow_mut(&mut self) -> &mut V {
| ^^^^^^^^^
note: ...so that the type `U` will meet its required lifetime bounds
--> $DIR/E0311.rs:14:9
|
LL | u_ref.borrow_mut()
| ^^^^^^^^^^^^^^^^^^
help: consider adding an explicit lifetime bound...
|
LL | U: BorrowMut<V> + 'a, // Error is caused by missing lifetime here
| ++++

error: aborting due to 2 previous errors

For more information about this error, try `rustc --explain E0311`.
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ LL | fn func<T: Test + 'a>(foo: &Foo, t: T) {

error: aborting due to previous error

For more information about this error, try `rustc --explain E0311`.
Original file line number Diff line number Diff line change
Expand Up @@ -162,5 +162,5 @@ LL | G: Get<T> + 'a,

error: aborting due to 8 previous errors

Some errors have detailed explanations: E0261, E0309, E0621, E0700.
Some errors have detailed explanations: E0261, E0309, E0311, E0621, E0700.
For more information about an error, try `rustc --explain E0261`.