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

Reference correct fn during lifetime elision documentation #21517

Merged
merged 1 commit into from
Jan 23, 2015
Merged
Changes from all 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
16 changes: 8 additions & 8 deletions src/doc/trpl/ownership.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,8 @@ three. The ownership system in Rust does this through a concept called
Remember the function that borrowed an `i32`? Let's look at it again.

```rust
fn add_one(num: &i32) -> i32 {
*num + 1
fn add_one(num: &mut i32) {
*num += 1;
}
```

Expand All @@ -255,8 +255,8 @@ cover the others later. Without eliding the lifetimes, `add_one` looks like
this:

```rust
fn add_one<'a>(num: &'a i32) -> i32 {
*num + 1
fn add_one<'a>(num: &'a mut i32) {
*num += 1;
}
```

Expand All @@ -278,12 +278,12 @@ fn add_two<'a, 'b>(...)
Then in our parameter list, we use the lifetimes we've named:

```{rust,ignore}
...(num: &'a i32) -> ...
...(num: &'a mut i32)
```

If you compare `&i32` to `&'a i32`, they're the same, it's just that the
lifetime `'a` has snuck in between the `&` and the `i32`. We read `&i32` as "a
reference to an i32" and `&'a i32` as "a reference to an i32 with the lifetime 'a.'"
If you compare `&mut i32` to `&'a mut i32`, they're the same, it's just that the
lifetime `'a` has snuck in between the `&` and the `mut i32`. We read `&mut i32` as "a
mutable reference to an i32" and `&'a mut i32` as "a mutable reference to an i32 with the lifetime 'a.'"

Why do lifetimes matter? Well, for example, here's some code:

Expand Down