Understanding usage of Rc<RefCell<SomeStruct>> in Rust

Question

I'm looking at some code that uses

Rc<RefCell<SomeStruct>>

So I went out to read about the differentes between Rc and RefCell:

Here is a recap of the reasons to choose Box, Rc, or RefCell:

Rc enables multiple owners of the same data; Box and RefCell have single owners.

Box allows immutable or mutable borrows checked at compile time; Rc allows only immutable borrows checked at compile time;

RefCell allows immutable or mutable borrows checked at runtime. Because RefCell allows mutable borrows checked at runtime, you can mutate the value inside the RefCell even when the RefCell is immutable.

So, Rc makes sure that SomeStruct is accessible by many people at the same time. But how do I access? I only see the get_mut method, which returns a mutable reference. But the text explained that "Rc allows only immutable borrows".

If it's possible to access Rc's object in mut and not mut way, why a RefCell is needed?

"Rc allows only immutable borrows" – where is this quote from? It's not entirely accurate, so I'd like to correct it. The official documentation only states "You cannot generally obtain a mutable reference to something inside an Rc." This is appropriately qualified with "generally", so I think it's fine. — Sven Marnach
@SvenMarnach it's from here doc.rust-lang.org/book/ch15-05-interior-mutability.html — Guerlando OCs
Thanks. I'm not really sure whether this should be updated. While strictly speaking it's not true that you can only get shared borrows for the inner value of an Rc, it's true in most practical cases, so making this more correct may make it more confusing in other respects. — Sven Marnach
Does this answer your question? Need holistic explanation about Rust's cell and reference counted types — trentcl

Sven Marnach Sven Marnach · Accepted Answer · 2020-05-25T08:09:26

So, Rc makes sure that SomeStruct is accessible by many people at the same time. But how do I access?

By dereferencing. If you have a variable x of type Rc<...>, you can access the inner value using *x. In many cases this happens implicitly; for example you can call methods on x simply with x.method(...).

I only see the get_mut method, which returns a mutable reference. But the text explained that "Rc allows only immutable borrows".

The get_mut() method is probably more recent than the explanation stating that Rc only allows immutable borrows. Moreover, it only returns a mutable borrow if there currently is only a single owner of the inner value, i.e. if you currently wouldn't need Rc in the first place. As soon as there are multiple owners, get_mut() will return None.

If it's possible to access Rc's object in mut and not mut way, why a RefCell is needed?

RefCell will allow you to get mutable access even when multiple owners exist, and even if you only hold a shared reference to the RefCell. It will dynamically check at runtime that only a single mutable reference exists at any given time, and it will panic if you request a second, concurrent one (or return and error for the try_borrow methods, respecitvely). This functionality is not offered by Rc.

So in summary, Rc gives you shared ownership. The innervalue has multiple owners, and reference counting makes sure the data stays alive as long as at least one owner still holds onto it. This is useful if your data doesn't have a clear single owner. RefCell gives you interior mutability, i.e. you can borrow the inner value dynamically at runtime, and modify it even with a shared reference. The combination Rc<RefCell<...>> gives you the combination of both – a value with multiple owners that can be borrowed mutably by any one of the owners.

For further details, you can read the relevant chapters of the Rust book:

Understanding usage of Rc<RefCell<SomeStruct>> in Rust

1 Answers