@@ -1619,17 +1619,18 @@ impl<T: ?Sized + fmt::Display> fmt::Display for RefMut<'_, T> {
1619
1619
1620
1620
/// The core primitive for interior mutability in Rust.
1621
1621
///
1622
- /// `UnsafeCell<T>` is a type that wraps some `T` and indicates unsafe interior operations on the
1623
- /// wrapped type. Types with an `UnsafeCell<T>` field are considered to have an 'unsafe interior'.
1624
- /// The `UnsafeCell<T>` type is the only legal way to obtain aliasable data that is considered
1625
- /// mutable. In general, transmuting a `&T` type into a `&mut T` is considered undefined behavior.
1622
+ /// If you have a reference `&T`, then normally in Rust the compiler performs optimizations based on
1623
+ /// the knowledge that `&T` points to immutable data. Mutating that data, for example through an
1624
+ /// alias or by transmuting an `&T` into an `&mut T`, is considered undefined behavior.
1625
+ /// `UnsafeCell<T>` opts-out of the immutability guarantee for `&T`: a shared reference
1626
+ /// `&UnsafeCell<T>` may point to data that is being mutated. This is called "interior mutability".
1626
1627
///
1627
- /// If you have a reference `&SomeStruct`, then normally in Rust all fields of `SomeStruct` are
1628
- /// immutable. The compiler makes optimizations based on the knowledge that `&T` is not mutably
1629
- /// aliased or mutated, and that `&mut T` is unique. `UnsafeCell<T>` is the only core language
1630
- /// feature to work around the restriction that `&T` may not be mutated. All other types that
1631
- /// allow internal mutability, such as `Cell<T>` and `RefCell<T>`, use `UnsafeCell` to wrap their
1632
- /// internal data. There is *no* legal way to obtain aliasing `&mut`, not even with `UnsafeCell<T>`.
1628
+ /// All other types that allow internal mutability, such as `Cell<T>` and `RefCell<T>`, internally
1629
+ /// use `UnsafeCell` to wrap their data.
1630
+ ///
1631
+ /// Note that only the immutability guarantee for shared references is affected by `UnsafeCell`. The
1632
+ /// uniqueness guarantee for mutable references is unaffected. There is *no* legal way to obtain
1633
+ /// aliasing `&mut`, not even with `UnsafeCell<T>`.
1633
1634
///
1634
1635
/// The `UnsafeCell` API itself is technically very simple: [`.get()`] gives you a raw pointer
1635
1636
/// `*mut T` to its contents. It is up to _you_ as the abstraction designer to use that raw pointer
0 commit comments