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 OnceCell to shared-mutability + splitting burrows speaker notes #107

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion training-slides/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Using Rust on Windows/macOS/Linux. Requires [Rust Fundamentals](#rust-fundamenta
* [Lifetimes](./lifetimes.md)
* [Cargo Workspaces](./cargo-workspaces.md)
* [Heap Allocation (Box and Rc)](./heap.md)
* [Shared Mutability (Cell, RefCell)](./shared-mutability.md)
* [Shared Mutability (Cell, RefCell, OnceCell)](./shared-mutability.md)
* [Thread Safety (Send/Sync, Arc, Mutex)](./thread-safety.md)
* [Closures and the Fn/FnOnce/FnMut traits](./closures.md)
* [Spawning Threads and Scoped Threads](./spawning-threads.md)
Expand Down
55 changes: 55 additions & 0 deletions training-slides/src/shared-mutability.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,29 @@ impl Post {
}
```

Note:

As an in-depth example of the borrowchecker's limitations, consider the [Splitting Borrows](https://doc.rust-lang.org/nomicon/borrow-splitting.html) idiom, which allows one to borrow different fields of the same struct with different mutability semantics:

```rust
struct Foo {
a: i32,
b: i32,
c: i32,
}

let mut x = Foo {a: 0, b: 0, c: 0};
let a = &mut x.a;
let b = &mut x.b;
let c = &x.c;
*b += 1;
let c2 = &x.c;
*a += 10;
println!("{} {} {} {}", a, b, c, c2);
```

The code works, but you *have* to use shadowing with `let a = &mut x.a;` or else the compiler will error. The borrowchecker is particularly frail here - replacing `Foo` with `x = [1,2,3]` and trying to borrow indexes will make it error out.
Copy link
Member

Choose a reason for hiding this comment

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

I don't know that "You have to use shadowing" is true here. This code works too:

    let mut x = Foo {a: 0, b: 0, c: 0};
    let c = &x.c;
    x.b += 1;
    let c2 = &x.c;
    x.a += 10;
    println!("{} {} {} {}", x.a, x.b, c, c2);

The main take-away I think we want here is that the borrow checker is special-cased for borrowing fields in structs and tuples, and the magic there does not apply to borrowing elements using the indexing operator, like with arrays or hashmaps:

This also works:

    let mut z = (1, 2);
    let r = &z.1;
    z.0 += 1;
    println!("{:?}, {}", z, r);

This does not:

    let mut z = [1, 2];
    let r = &z[1];
    z[0] += 1;
    println!("{:?}, {}", z, r);


## `RefCell`

A `RefCell` is also safe, but lets you *borrow* or *mutably borrow* the contents.
Expand Down Expand Up @@ -252,3 +275,35 @@ To get *shared ownership* and *mutability* you need two things:

* `Rc<RefCell<T>>`
* (Multi-threaded programs might use `Arc<Mutex<T>>`)

## `OnceCell` for special cases

If you only need to modify a field *once*, a `OnceCell` can help you keep the ownership system checks at compile-time
Copy link
Member

Choose a reason for hiding this comment

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

Can we link to the std-library docs on OnceCell?


```rust
use std::time::Instant;

fn main() {
let post = Post {
content: String::from("Blah"),
..Post::default()
};
assert!(post.first_viewed_at.get().is_none());
println!("{:?}", post.date_of_first_view());
assert!(post.first_viewed_at.get().is_some());
}

#[derive(Debug, Default)]
struct Post {
content: String,
first_viewed_at: std::cell::OnceCell<Instant>,
}

impl Post {
fn date_of_first_view(&self) -> Instant {
*self.first_viewed_at.get_or_init(Instant::now)
}
}
```

A [LazyCell](https://doc.rust-lang.org/std/cell/struct.LazyCell.html) will do this initialization lazily, and a [LazyLock](https://doc.rust-lang.org/std/sync/struct.LazyLock.html) will do it in a threadsafe way.
Copy link
Member

Choose a reason for hiding this comment

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

I'm afraid I didn't understand the difference between OnceCell and LazyCell after reading this note. I also observe that OnceLock exists.

The primary difference is that a LazyCell owns its initialisation function - it is passed when the cell is constructed, not when the cell is accessed. See https://doc.rust-lang.org/std/cell/index.html#oncecellt and https://doc.rust-lang.org/std/cell/index.html#lazycellt-f. However both are equally 'lazy' in that the function is not called at construction time - it is only called on first access (either explicitly or implicitly).

Loading