rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Rollup merge of #39299 - federicomenaquintero:master, r=GuillaumeGomez

Browse Source 
In std:rc, clarify the lack of mutability inside an Rc

Also, point to the example in Cell's docs for how to do it.
This commit is contained in:
Guillaume Gomez
2017-02-02 22:22:22 +01:00
committed by GitHub
parent 38ae9233b5 4a07e722c0
commit b03436d2e3
1 changed files with 6 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
src/liballoc/rc.rs
View File

@@ -17,9 +17,11 @@
//! pointer to the same value in the heap. When the last [`Rc`] pointer to a //! pointer to the same value in the heap. When the last [`Rc`] pointer to a
//! given value is destroyed, the pointed-to value is also destroyed. //! given value is destroyed, the pointed-to value is also destroyed.
//! //!
//! Shared references in Rust disallow mutation by default, and `Rc` is no //! Shared references in Rust disallow mutation by default, and [`Rc`]
//! exception. If you need to mutate through an [`Rc`], use [`Cell`] or //! is no exception: you cannot obtain a mutable reference to
//! [`RefCell`]. //! something inside an [`Rc`]. If you need mutability, put a [`Cell`]
//! or [`RefCell`] inside the [`Rc`]; see [an example of mutability
//! inside an Rc][mutability].
//! //!
//! [`Rc`] uses non-atomic reference counting. This means that overhead is very //! [`Rc`] uses non-atomic reference counting. This means that overhead is very
//! low, but an [`Rc`] cannot be sent between threads, and consequently [`Rc`] //! low, but an [`Rc`] cannot be sent between threads, and consequently [`Rc`]
@@ -214,6 +216,7 @@
//! [upgrade]: struct.Weak.html#method.upgrade //! [upgrade]: struct.Weak.html#method.upgrade
//! [`None`]: ../../std/option/enum.Option.html#variant.None //! [`None`]: ../../std/option/enum.Option.html#variant.None
//! [assoc]: ../../book/method-syntax.html#associated-functions //! [assoc]: ../../book/method-syntax.html#associated-functions
//! [mutability]: ../../std/cell/index.html#introducing-mutability-inside-of-something-immutable
#![stable(feature = "rust1", since = "1.0.0")] #![stable(feature = "rust1", since = "1.0.0")]