src/libcore/cell.rs

   1 //! Shareable mutable containers.
   2 //!
   3 //! Rust memory safety is based on this rule: Given an object `T`, it is only possible to
   4 //! have one of the following:
   5 //!
   6 //! - Having several immutable references (`&T`) to the object (also known as **aliasing**).
   7 //! - Having one mutable reference (`&mut T`) to the object (also known as **mutability**).
   8 //!
   9 //! This is enforced by the Rust compiler. However, there are situations where this rule is not
  10 //! flexible enough. Sometimes it is required to have multiple references to an object and yet
  11 //! mutate it.
  12 //!
  13 //! Shareable mutable containers exist to permit mutability in a controlled manner, even in the
  14 //! presence of aliasing. Both `Cell<T>` and `RefCell<T>` allow doing this in a single-threaded
  15 //! way. However, neither `Cell<T>` nor `RefCell<T>` are thread safe (they do not implement
  16 //! `Sync`). If you need to do aliasing and mutation between multiple threads it is possible to
  17 //! use [`Mutex`](../../std/sync/struct.Mutex.html),
  18 //! [`RwLock`](../../std/sync/struct.RwLock.html) or
  19 //! [`atomic`](../../core/sync/atomic/index.html) types.
  20 //!
  21 //! Values of the `Cell<T>` and `RefCell<T>` types may be mutated through shared references (i.e.
  22 //! the common `&T` type), whereas most Rust types can only be mutated through unique (`&mut T`)
  23 //! references. We say that `Cell<T>` and `RefCell<T>` provide 'interior mutability', in contrast
  24 //! with typical Rust types that exhibit 'inherited mutability'.
  25 //!
  26 //! Cell types come in two flavors: `Cell<T>` and `RefCell<T>`. `Cell<T>` implements interior
  27 //! mutability by moving values in and out of the `Cell<T>`. To use references instead of values,
  28 //! one must use the `RefCell<T>` type, acquiring a write lock before mutating. `Cell<T>` provides
  29 //! methods to retrieve and change the current interior value:
  30 //!
  31 //!  - For types that implement `Copy`, the `get` method retrieves the current interior value.
  32 //!  - For types that implement `Default`, the `take` method replaces the current interior value
  33 //!    with `Default::default()` and returns the replaced value.
  34 //!  - For all types, the `replace` method replaces the current interior value and returns the
  35 //!    replaced value and the `into_inner` method consumes the `Cell<T>` and returns the interior
  36 //!    value. Additionally, the `set` method replaces the interior value, dropping the replaced
  37 //!    value.
  38 //!
  39 //! `RefCell<T>` uses Rust's lifetimes to implement 'dynamic borrowing', a process whereby one can
  40 //! claim temporary, exclusive, mutable access to the inner value. Borrows for `RefCell<T>`s are
  41 //! tracked 'at runtime', unlike Rust's native reference types which are entirely tracked
  42 //! statically, at compile time. Because `RefCell<T>` borrows are dynamic it is possible to attempt
  43 //! to borrow a value that is already mutably borrowed; when this happens it results in thread
  44 //! panic.
  45 //!
  46 //! # When to choose interior mutability
  47 //!
  48 //! The more common inherited mutability, where one must have unique access to mutate a value, is
  49 //! one of the key language elements that enables Rust to reason strongly about pointer aliasing,
  50 //! statically preventing crash bugs. Because of that, inherited mutability is preferred, and
  51 //! interior mutability is something of a last resort. Since cell types enable mutation where it
  52 //! would otherwise be disallowed though, there are occasions when interior mutability might be
  53 //! appropriate, or even *must* be used, e.g.
  54 //!
  55 //! * Introducing mutability 'inside' of something immutable
  56 //! * Implementation details of logically-immutable methods.
  57 //! * Mutating implementations of `Clone`.
  58 //!
  59 //! ## Introducing mutability 'inside' of something immutable
  60 //!
  61 //! Many shared smart pointer types, including `Rc<T>` and `Arc<T>`, provide containers that can be
  62 //! cloned and shared between multiple parties. Because the contained values may be
  63 //! multiply-aliased, they can only be borrowed with `&`, not `&mut`. Without cells it would be
  64 //! impossible to mutate data inside of these smart pointers at all.
  65 //!
  66 //! It's very common then to put a `RefCell<T>` inside shared pointer types to reintroduce
  67 //! mutability:
  68 //!
  69 //! ```
  70 //! use std::cell::{RefCell, RefMut};
  71 //! use std::collections::HashMap;
  72 //! use std::rc::Rc;
  73 //!
  74 //! fn main() {
  75 //!     let shared_map: Rc<RefCell<_>> = Rc::new(RefCell::new(HashMap::new()));
  76 //!     // Create a new block to limit the scope of the dynamic borrow
  77 //!     {
  78 //!         let mut map: RefMut<_> = shared_map.borrow_mut();
  79 //!         map.insert("africa", 92388);
  80 //!         map.insert("kyoto", 11837);
  81 //!         map.insert("piccadilly", 11826);
  82 //!         map.insert("marbles", 38);
  83 //!     }
  84 //!
  85 //!     // Note that if we had not let the previous borrow of the cache fall out
  86 //!     // of scope then the subsequent borrow would cause a dynamic thread panic.
  87 //!     // This is the major hazard of using `RefCell`.
  88 //!     let total: i32 = shared_map.borrow().values().sum();
  89 //!     println!("{}", total);
  90 //! }
  91 //! ```
  92 //!
  93 //! Note that this example uses `Rc<T>` and not `Arc<T>`. `RefCell<T>`s are for single-threaded
  94 //! scenarios. Consider using `RwLock<T>` or `Mutex<T>` if you need shared mutability in a
  95 //! multi-threaded situation.
  96 //!
  97 //! ## Implementation details of logically-immutable methods
  98 //!
  99 //! Occasionally it may be desirable not to expose in an API that there is mutation happening
 100 //! "under the hood". This may be because logically the operation is immutable, but e.g., caching
 101 //! forces the implementation to perform mutation; or because you must employ mutation to implement
 102 //! a trait method that was originally defined to take `&self`.
 103 //!
 104 //! ```
 105 //! # #![allow(dead_code)]
 106 //! use std::cell::RefCell;
 107 //!
 108 //! struct Graph {
 109 //!     edges: Vec<(i32, i32)>,
 110 //!     span_tree_cache: RefCell<Option<Vec<(i32, i32)>>>
 111 //! }
 112 //!
 113 //! impl Graph {
 114 //!     fn minimum_spanning_tree(&self) -> Vec<(i32, i32)> {
 115 //!         self.span_tree_cache.borrow_mut()
 116 //!             .get_or_insert_with(|| self.calc_span_tree())
 117 //!             .clone()
 118 //!     }
 119 //!
 120 //!     fn calc_span_tree(&self) -> Vec<(i32, i32)> {
 121 //!         // Expensive computation goes here
 122 //!         vec![]
 123 //!     }
 124 //! }
 125 //! ```
 126 //!
 127 //! ## Mutating implementations of `Clone`
 128 //!
 129 //! This is simply a special - but common - case of the previous: hiding mutability for operations
 130 //! that appear to be immutable. The `clone` method is expected to not change the source value, and
 131 //! is declared to take `&self`, not `&mut self`. Therefore, any mutation that happens in the
 132 //! `clone` method must use cell types. For example, `Rc<T>` maintains its reference counts within a
 133 //! `Cell<T>`.
 134 //!
 135 //! ```
 136 //! use std::cell::Cell;
 137 //! use std::ptr::NonNull;
 138 //! use std::process::abort;
 139 //! use std::marker::PhantomData;
 140 //!
 141 //! struct Rc<T: ?Sized> {
 142 //!     ptr: NonNull<RcBox<T>>,
 143 //!     phantom: PhantomData<RcBox<T>>,
 144 //! }
 145 //!
 146 //! struct RcBox<T: ?Sized> {
 147 //!     strong: Cell<usize>,
 148 //!     refcount: Cell<usize>,
 149 //!     value: T,
 150 //! }
 151 //!
 152 //! impl<T: ?Sized> Clone for Rc<T> {
 153 //!     fn clone(&self) -> Rc<T> {
 154 //!         self.inc_strong();
 155 //!         Rc {
 156 //!             ptr: self.ptr,
 157 //!             phantom: PhantomData,
 158 //!         }
 159 //!     }
 160 //! }
 161 //!
 162 //! trait RcBoxPtr<T: ?Sized> {
 163 //!
 164 //!     fn inner(&self) -> &RcBox<T>;
 165 //!
 166 //!     fn strong(&self) -> usize {
 167 //!         self.inner().strong.get()
 168 //!     }
 169 //!
 170 //!     fn inc_strong(&self) {
 171 //!         self.inner()
 172 //!             .strong
 173 //!             .set(self.strong()
 174 //!                      .checked_add(1)
 175 //!                      .unwrap_or_else(|| abort() ));
 176 //!     }
 177 //! }
 178 //!
 179 //! impl<T: ?Sized> RcBoxPtr<T> for Rc<T> {
 180 //!    fn inner(&self) -> &RcBox<T> {
 181 //!        unsafe {
 182 //!            self.ptr.as_ref()
 183 //!        }
 184 //!    }
 185 //! }
 186 //! ```
 187 //!
 188
 189 #![stable(feature = "rust1", since = "1.0.0")]
 190
 191 use crate::cmp::Ordering;
 192 use crate::fmt::{self, Debug, Display};
 193 use crate::marker::Unsize;
 194 use crate::mem;
 195 use crate::ops::{CoerceUnsized, Deref, DerefMut};
 196 use crate::ptr;
 197
 198 /// A mutable memory location.
 199 ///
 200 /// # Examples
 201 ///
 202 /// In this example, you can see that `Cell<T>` enables mutation inside an
 203 /// immutable struct. In other words, it enables "interior mutability".
 204 ///
 205 /// ```
 206 /// use std::cell::Cell;
 207 ///
 208 /// struct SomeStruct {
 209 ///     regular_field: u8,
 210 ///     special_field: Cell<u8>,
 211 /// }
 212 ///
 213 /// let my_struct = SomeStruct {
 214 ///     regular_field: 0,
 215 ///     special_field: Cell::new(1),
 216 /// };
 217 ///
 218 /// let new_value = 100;
 219 ///
 220 /// // ERROR: `my_struct` is immutable
 221 /// // my_struct.regular_field = new_value;
 222 ///
 223 /// // WORKS: although `my_struct` is immutable, `special_field` is a `Cell`,
 224 /// // which can always be mutated
 225 /// my_struct.special_field.set(new_value);
 226 /// assert_eq!(my_struct.special_field.get(), new_value);
 227 /// ```
 228 ///
 229 /// See the [module-level documentation](index.html) for more.
 230 #[stable(feature = "rust1", since = "1.0.0")]
 231 #[repr(transparent)]
 232 pub struct Cell<T: ?Sized> {
 233     value: UnsafeCell<T>,
 234 }
 235
 236 #[stable(feature = "rust1", since = "1.0.0")]
 237 unsafe impl<T: ?Sized> Send for Cell<T> where T: Send {}
 238
 239 #[stable(feature = "rust1", since = "1.0.0")]
 240 impl<T: ?Sized> !Sync for Cell<T> {}
 241
 242 #[stable(feature = "rust1", since = "1.0.0")]
 243 impl<T: Copy> Clone for Cell<T> {
 244     #[inline]
 245     fn clone(&self) -> Cell<T> {
 246         Cell::new(self.get())
 247     }
 248 }
 249
 250 #[stable(feature = "rust1", since = "1.0.0")]
 251 impl<T: Default> Default for Cell<T> {
 252     /// Creates a `Cell<T>`, with the `Default` value for T.
 253     #[inline]
 254     fn default() -> Cell<T> {
 255         Cell::new(Default::default())
 256     }
 257 }
 258
 259 #[stable(feature = "rust1", since = "1.0.0")]
 260 impl<T: PartialEq + Copy> PartialEq for Cell<T> {
 261     #[inline]
 262     fn eq(&self, other: &Cell<T>) -> bool {
 263         self.get() == other.get()
 264     }
 265 }
 266
 267 #[stable(feature = "cell_eq", since = "1.2.0")]
 268 impl<T: Eq + Copy> Eq for Cell<T> {}
 269
 270 #[stable(feature = "cell_ord", since = "1.10.0")]
 271 impl<T: PartialOrd + Copy> PartialOrd for Cell<T> {
 272     #[inline]
 273     fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering> {
 274         self.get().partial_cmp(&other.get())
 275     }
 276
 277     #[inline]
 278     fn lt(&self, other: &Cell<T>) -> bool {
 279         self.get() < other.get()
 280     }
 281
 282     #[inline]
 283     fn le(&self, other: &Cell<T>) -> bool {
 284         self.get() <= other.get()
 285     }
 286
 287     #[inline]
 288     fn gt(&self, other: &Cell<T>) -> bool {
 289         self.get() > other.get()
 290     }
 291
 292     #[inline]
 293     fn ge(&self, other: &Cell<T>) -> bool {
 294         self.get() >= other.get()
 295     }
 296 }
 297
 298 #[stable(feature = "cell_ord", since = "1.10.0")]
 299 impl<T: Ord + Copy> Ord for Cell<T> {
 300     #[inline]
 301     fn cmp(&self, other: &Cell<T>) -> Ordering {
 302         self.get().cmp(&other.get())
 303     }
 304 }
 305
 306 #[stable(feature = "cell_from", since = "1.12.0")]
 307 impl<T> From<T> for Cell<T> {
 308     fn from(t: T) -> Cell<T> {
 309         Cell::new(t)
 310     }
 311 }
 312
 313 impl<T> Cell<T> {
 314     /// Creates a new `Cell` containing the given value.
 315     ///
 316     /// # Examples
 317     ///
 318     /// ```
 319     /// use std::cell::Cell;
 320     ///
 321     /// let c = Cell::new(5);
 322     /// ```
 323     #[stable(feature = "rust1", since = "1.0.0")]
 324     #[rustc_const_stable(feature = "const_cell_new", since = "1.32.0")]
 325     #[inline]
 326     pub const fn new(value: T) -> Cell<T> {
 327         Cell { value: UnsafeCell::new(value) }
 328     }
 329
 330     /// Sets the contained value.
 331     ///
 332     /// # Examples
 333     ///
 334     /// ```
 335     /// use std::cell::Cell;
 336     ///
 337     /// let c = Cell::new(5);
 338     ///
 339     /// c.set(10);
 340     /// ```
 341     #[inline]
 342     #[stable(feature = "rust1", since = "1.0.0")]
 343     pub fn set(&self, val: T) {
 344         let old = self.replace(val);
 345         drop(old);
 346     }
 347
 348     /// Swaps the values of two Cells.
 349     /// Difference with `std::mem::swap` is that this function doesn't require `&mut` reference.
 350     ///
 351     /// # Examples
 352     ///
 353     /// ```
 354     /// use std::cell::Cell;
 355     ///
 356     /// let c1 = Cell::new(5i32);
 357     /// let c2 = Cell::new(10i32);
 358     /// c1.swap(&c2);
 359     /// assert_eq!(10, c1.get());
 360     /// assert_eq!(5, c2.get());
 361     /// ```
 362     #[inline]
 363     #[stable(feature = "move_cell", since = "1.17.0")]
 364     pub fn swap(&self, other: &Self) {
 365         if ptr::eq(self, other) {
 366             return;
 367         }
 368         // SAFETY: This can be risky if called from separate threads, but `Cell`
 369         // is `!Sync` so this won't happen. This also won't invalidate any
 370         // pointers since `Cell` makes sure nothing else will be pointing into
 371         // either of these `Cell`s.
 372         unsafe {
 373             ptr::swap(self.value.get(), other.value.get());
 374         }
 375     }
 376
 377     /// Replaces the contained value, and returns it.
 378     ///
 379     /// # Examples
 380     ///
 381     /// ```
 382     /// use std::cell::Cell;
 383     ///
 384     /// let cell = Cell::new(5);
 385     /// assert_eq!(cell.get(), 5);
 386     /// assert_eq!(cell.replace(10), 5);
 387     /// assert_eq!(cell.get(), 10);
 388     /// ```
 389     #[stable(feature = "move_cell", since = "1.17.0")]
 390     pub fn replace(&self, val: T) -> T {
 391         // SAFETY: This can cause data races if called from a separate thread,
 392         // but `Cell` is `!Sync` so this won't happen.
 393         mem::replace(unsafe { &mut *self.value.get() }, val)
 394     }
 395
 396     /// Unwraps the value.
 397     ///
 398     /// # Examples
 399     ///
 400     /// ```
 401     /// use std::cell::Cell;
 402     ///
 403     /// let c = Cell::new(5);
 404     /// let five = c.into_inner();
 405     ///
 406     /// assert_eq!(five, 5);
 407     /// ```
 408     #[stable(feature = "move_cell", since = "1.17.0")]
 409     pub fn into_inner(self) -> T {
 410         self.value.into_inner()
 411     }
 412 }
 413
 414 impl<T: Copy> Cell<T> {
 415     /// Returns a copy of the contained value.
 416     ///
 417     /// # Examples
 418     ///
 419     /// ```
 420     /// use std::cell::Cell;
 421     ///
 422     /// let c = Cell::new(5);
 423     ///
 424     /// let five = c.get();
 425     /// ```
 426     #[inline]
 427     #[stable(feature = "rust1", since = "1.0.0")]
 428     pub fn get(&self) -> T {
 429         // SAFETY: This can cause data races if called from a separate thread,
 430         // but `Cell` is `!Sync` so this won't happen.
 431         unsafe { *self.value.get() }
 432     }
 433
 434     /// Updates the contained value using a function and returns the new value.
 435     ///
 436     /// # Examples
 437     ///
 438     /// ```
 439     /// #![feature(cell_update)]
 440     ///
 441     /// use std::cell::Cell;
 442     ///
 443     /// let c = Cell::new(5);
 444     /// let new = c.update(|x| x + 1);
 445     ///
 446     /// assert_eq!(new, 6);
 447     /// assert_eq!(c.get(), 6);
 448     /// ```
 449     #[inline]
 450     #[unstable(feature = "cell_update", issue = "50186")]
 451     pub fn update<F>(&self, f: F) -> T
 452     where
 453         F: FnOnce(T) -> T,
 454     {
 455         let old = self.get();
 456         let new = f(old);
 457         self.set(new);
 458         new
 459     }
 460 }
 461
 462 impl<T: ?Sized> Cell<T> {
 463     /// Returns a raw pointer to the underlying data in this cell.
 464     ///
 465     /// # Examples
 466     ///
 467     /// ```
 468     /// use std::cell::Cell;
 469     ///
 470     /// let c = Cell::new(5);
 471     ///
 472     /// let ptr = c.as_ptr();
 473     /// ```
 474     #[inline]
 475     #[stable(feature = "cell_as_ptr", since = "1.12.0")]
 476     #[rustc_const_stable(feature = "const_cell_as_ptr", since = "1.32.0")]
 477     pub const fn as_ptr(&self) -> *mut T {
 478         self.value.get()
 479     }
 480
 481     /// Returns a mutable reference to the underlying data.
 482     ///
 483     /// This call borrows `Cell` mutably (at compile-time) which guarantees
 484     /// that we possess the only reference.
 485     ///
 486     /// # Examples
 487     ///
 488     /// ```
 489     /// use std::cell::Cell;
 490     ///
 491     /// let mut c = Cell::new(5);
 492     /// *c.get_mut() += 1;
 493     ///
 494     /// assert_eq!(c.get(), 6);
 495     /// ```
 496     #[inline]
 497     #[stable(feature = "cell_get_mut", since = "1.11.0")]
 498     pub fn get_mut(&mut self) -> &mut T {
 499         // SAFETY: This can cause data races if called from a separate thread,
 500         // but `Cell` is `!Sync` so this won't happen, and `&mut` guarantees
 501         // unique access.
 502         unsafe { &mut *self.value.get() }
 503     }
 504
 505     /// Returns a `&Cell<T>` from a `&mut T`
 506     ///
 507     /// # Examples
 508     ///
 509     /// ```
 510     /// use std::cell::Cell;
 511     ///
 512     /// let slice: &mut [i32] = &mut [1, 2, 3];
 513     /// let cell_slice: &Cell<[i32]> = Cell::from_mut(slice);
 514     /// let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();
 515     ///
 516     /// assert_eq!(slice_cell.len(), 3);
 517     /// ```
 518     #[inline]
 519     #[stable(feature = "as_cell", since = "1.37.0")]
 520     pub fn from_mut(t: &mut T) -> &Cell<T> {
 521         // SAFETY: `&mut` ensures unique access.
 522         unsafe { &*(t as *mut T as *const Cell<T>) }
 523     }
 524 }
 525
 526 impl<T: Default> Cell<T> {
 527     /// Takes the value of the cell, leaving `Default::default()` in its place.
 528     ///
 529     /// # Examples
 530     ///
 531     /// ```
 532     /// use std::cell::Cell;
 533     ///
 534     /// let c = Cell::new(5);
 535     /// let five = c.take();
 536     ///
 537     /// assert_eq!(five, 5);
 538     /// assert_eq!(c.into_inner(), 0);
 539     /// ```
 540     #[stable(feature = "move_cell", since = "1.17.0")]
 541     pub fn take(&self) -> T {
 542         self.replace(Default::default())
 543     }
 544 }
 545
 546 #[unstable(feature = "coerce_unsized", issue = "27732")]
 547 impl<T: CoerceUnsized<U>, U> CoerceUnsized<Cell<U>> for Cell<T> {}
 548
 549 impl<T> Cell<[T]> {
 550     /// Returns a `&[Cell<T>]` from a `&Cell<[T]>`
 551     ///
 552     /// # Examples
 553     ///
 554     /// ```
 555     /// use std::cell::Cell;
 556     ///
 557     /// let slice: &mut [i32] = &mut [1, 2, 3];
 558     /// let cell_slice: &Cell<[i32]> = Cell::from_mut(slice);
 559     /// let slice_cell: &[Cell<i32>] = cell_slice.as_slice_of_cells();
 560     ///
 561     /// assert_eq!(slice_cell.len(), 3);
 562     /// ```
 563     #[stable(feature = "as_cell", since = "1.37.0")]
 564     pub fn as_slice_of_cells(&self) -> &[Cell<T>] {
 565         // SAFETY: `Cell<T>` has the same memory layout as `T`.
 566         unsafe { &*(self as *const Cell<[T]> as *const [Cell<T>]) }
 567     }
 568 }
 569
 570 /// A mutable memory location with dynamically checked borrow rules
 571 ///
 572 /// See the [module-level documentation](index.html) for more.
 573 #[stable(feature = "rust1", since = "1.0.0")]
 574 pub struct RefCell<T: ?Sized> {
 575     borrow: Cell<BorrowFlag>,
 576     value: UnsafeCell<T>,
 577 }
 578
 579 /// An error returned by [`RefCell::try_borrow`](struct.RefCell.html#method.try_borrow).
 580 #[stable(feature = "try_borrow", since = "1.13.0")]
 581 pub struct BorrowError {
 582     _private: (),
 583 }
 584
 585 #[stable(feature = "try_borrow", since = "1.13.0")]
 586 impl Debug for BorrowError {
 587     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 588         f.debug_struct("BorrowError").finish()
 589     }
 590 }
 591
 592 #[stable(feature = "try_borrow", since = "1.13.0")]
 593 impl Display for BorrowError {
 594     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 595         Display::fmt("already mutably borrowed", f)
 596     }
 597 }
 598
 599 /// An error returned by [`RefCell::try_borrow_mut`](struct.RefCell.html#method.try_borrow_mut).
 600 #[stable(feature = "try_borrow", since = "1.13.0")]
 601 pub struct BorrowMutError {
 602     _private: (),
 603 }
 604
 605 #[stable(feature = "try_borrow", since = "1.13.0")]
 606 impl Debug for BorrowMutError {
 607     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 608         f.debug_struct("BorrowMutError").finish()
 609     }
 610 }
 611
 612 #[stable(feature = "try_borrow", since = "1.13.0")]
 613 impl Display for BorrowMutError {
 614     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 615         Display::fmt("already borrowed", f)
 616     }
 617 }
 618
 619 // Positive values represent the number of `Ref` active. Negative values
 620 // represent the number of `RefMut` active. Multiple `RefMut`s can only be
 621 // active at a time if they refer to distinct, nonoverlapping components of a
 622 // `RefCell` (e.g., different ranges of a slice).
 623 //
 624 // `Ref` and `RefMut` are both two words in size, and so there will likely never
 625 // be enough `Ref`s or `RefMut`s in existence to overflow half of the `usize`
 626 // range. Thus, a `BorrowFlag` will probably never overflow or underflow.
 627 // However, this is not a guarantee, as a pathological program could repeatedly
 628 // create and then mem::forget `Ref`s or `RefMut`s. Thus, all code must
 629 // explicitly check for overflow and underflow in order to avoid unsafety, or at
 630 // least behave correctly in the event that overflow or underflow happens (e.g.,
 631 // see BorrowRef::new).
 632 type BorrowFlag = isize;
 633 const UNUSED: BorrowFlag = 0;
 634
 635 #[inline(always)]
 636 fn is_writing(x: BorrowFlag) -> bool {
 637     x < UNUSED
 638 }
 639
 640 #[inline(always)]
 641 fn is_reading(x: BorrowFlag) -> bool {
 642     x > UNUSED
 643 }
 644
 645 impl<T> RefCell<T> {
 646     /// Creates a new `RefCell` containing `value`.
 647     ///
 648     /// # Examples
 649     ///
 650     /// ```
 651     /// use std::cell::RefCell;
 652     ///
 653     /// let c = RefCell::new(5);
 654     /// ```
 655     #[stable(feature = "rust1", since = "1.0.0")]
 656     #[rustc_const_stable(feature = "const_refcell_new", since = "1.32.0")]
 657     #[inline]
 658     pub const fn new(value: T) -> RefCell<T> {
 659         RefCell { value: UnsafeCell::new(value), borrow: Cell::new(UNUSED) }
 660     }
 661
 662     /// Consumes the `RefCell`, returning the wrapped value.
 663     ///
 664     /// # Examples
 665     ///
 666     /// ```
 667     /// use std::cell::RefCell;
 668     ///
 669     /// let c = RefCell::new(5);
 670     ///
 671     /// let five = c.into_inner();
 672     /// ```
 673     #[stable(feature = "rust1", since = "1.0.0")]
 674     #[inline]
 675     pub fn into_inner(self) -> T {
 676         // Since this function takes `self` (the `RefCell`) by value, the
 677         // compiler statically verifies that it is not currently borrowed.
 678         // Therefore the following assertion is just a `debug_assert!`.
 679         debug_assert!(self.borrow.get() == UNUSED);
 680         self.value.into_inner()
 681     }
 682
 683     /// Replaces the wrapped value with a new one, returning the old value,
 684     /// without deinitializing either one.
 685     ///
 686     /// This function corresponds to [`std::mem::replace`](../mem/fn.replace.html).
 687     ///
 688     /// # Panics
 689     ///
 690     /// Panics if the value is currently borrowed.
 691     ///
 692     /// # Examples
 693     ///
 694     /// ```
 695     /// use std::cell::RefCell;
 696     /// let cell = RefCell::new(5);
 697     /// let old_value = cell.replace(6);
 698     /// assert_eq!(old_value, 5);
 699     /// assert_eq!(cell, RefCell::new(6));
 700     /// ```
 701     #[inline]
 702     #[stable(feature = "refcell_replace", since = "1.24.0")]
 703     pub fn replace(&self, t: T) -> T {
 704         mem::replace(&mut *self.borrow_mut(), t)
 705     }
 706
 707     /// Replaces the wrapped value with a new one computed from `f`, returning
 708     /// the old value, without deinitializing either one.
 709     ///
 710     /// # Panics
 711     ///
 712     /// Panics if the value is currently borrowed.
 713     ///
 714     /// # Examples
 715     ///
 716     /// ```
 717     /// use std::cell::RefCell;
 718     /// let cell = RefCell::new(5);
 719     /// let old_value = cell.replace_with(|&mut old| old + 1);
 720     /// assert_eq!(old_value, 5);
 721     /// assert_eq!(cell, RefCell::new(6));
 722     /// ```
 723     #[inline]
 724     #[stable(feature = "refcell_replace_swap", since = "1.35.0")]
 725     pub fn replace_with<F: FnOnce(&mut T) -> T>(&self, f: F) -> T {
 726         let mut_borrow = &mut *self.borrow_mut();
 727         let replacement = f(mut_borrow);
 728         mem::replace(mut_borrow, replacement)
 729     }
 730
 731     /// Swaps the wrapped value of `self` with the wrapped value of `other`,
 732     /// without deinitializing either one.
 733     ///
 734     /// This function corresponds to [`std::mem::swap`](../mem/fn.swap.html).
 735     ///
 736     /// # Panics
 737     ///
 738     /// Panics if the value in either `RefCell` is currently borrowed.
 739     ///
 740     /// # Examples
 741     ///
 742     /// ```
 743     /// use std::cell::RefCell;
 744     /// let c = RefCell::new(5);
 745     /// let d = RefCell::new(6);
 746     /// c.swap(&d);
 747     /// assert_eq!(c, RefCell::new(6));
 748     /// assert_eq!(d, RefCell::new(5));
 749     /// ```
 750     #[inline]
 751     #[stable(feature = "refcell_swap", since = "1.24.0")]
 752     pub fn swap(&self, other: &Self) {
 753         mem::swap(&mut *self.borrow_mut(), &mut *other.borrow_mut())
 754     }
 755 }
 756
 757 impl<T: ?Sized> RefCell<T> {
 758     /// Immutably borrows the wrapped value.
 759     ///
 760     /// The borrow lasts until the returned `Ref` exits scope. Multiple
 761     /// immutable borrows can be taken out at the same time.
 762     ///
 763     /// # Panics
 764     ///
 765     /// Panics if the value is currently mutably borrowed. For a non-panicking variant, use
 766     /// [`try_borrow`](#method.try_borrow).
 767     ///
 768     /// # Examples
 769     ///
 770     /// ```
 771     /// use std::cell::RefCell;
 772     ///
 773     /// let c = RefCell::new(5);
 774     ///
 775     /// let borrowed_five = c.borrow();
 776     /// let borrowed_five2 = c.borrow();
 777     /// ```
 778     ///
 779     /// An example of panic:
 780     ///
 781     /// ```should_panic
 782     /// use std::cell::RefCell;
 783     ///
 784     /// let c = RefCell::new(5);
 785     ///
 786     /// let m = c.borrow_mut();
 787     /// let b = c.borrow(); // this causes a panic
 788     /// ```
 789     #[stable(feature = "rust1", since = "1.0.0")]
 790     #[inline]
 791     pub fn borrow(&self) -> Ref<'_, T> {
 792         self.try_borrow().expect("already mutably borrowed")
 793     }
 794
 795     /// Immutably borrows the wrapped value, returning an error if the value is currently mutably
 796     /// borrowed.
 797     ///
 798     /// The borrow lasts until the returned `Ref` exits scope. Multiple immutable borrows can be
 799     /// taken out at the same time.
 800     ///
 801     /// This is the non-panicking variant of [`borrow`](#method.borrow).
 802     ///
 803     /// # Examples
 804     ///
 805     /// ```
 806     /// use std::cell::RefCell;
 807     ///
 808     /// let c = RefCell::new(5);
 809     ///
 810     /// {
 811     ///     let m = c.borrow_mut();
 812     ///     assert!(c.try_borrow().is_err());
 813     /// }
 814     ///
 815     /// {
 816     ///     let m = c.borrow();
 817     ///     assert!(c.try_borrow().is_ok());
 818     /// }
 819     /// ```
 820     #[stable(feature = "try_borrow", since = "1.13.0")]
 821     #[inline]
 822     pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError> {
 823         match BorrowRef::new(&self.borrow) {
 824             // SAFETY: `BorrowRef` ensures that there is only immutable access
 825             // to the value while borrowed.
 826             Some(b) => Ok(Ref { value: unsafe { &*self.value.get() }, borrow: b }),
 827             None => Err(BorrowError { _private: () }),
 828         }
 829     }
 830
 831     /// Mutably borrows the wrapped value.
 832     ///
 833     /// The borrow lasts until the returned `RefMut` or all `RefMut`s derived
 834     /// from it exit scope. The value cannot be borrowed while this borrow is
 835     /// active.
 836     ///
 837     /// # Panics
 838     ///
 839     /// Panics if the value is currently borrowed. For a non-panicking variant, use
 840     /// [`try_borrow_mut`](#method.try_borrow_mut).
 841     ///
 842     /// # Examples
 843     ///
 844     /// ```
 845     /// use std::cell::RefCell;
 846     ///
 847     /// let c = RefCell::new("hello".to_owned());
 848     ///
 849     /// *c.borrow_mut() = "bonjour".to_owned();
 850     ///
 851     /// assert_eq!(&*c.borrow(), "bonjour");
 852     /// ```
 853     ///
 854     /// An example of panic:
 855     ///
 856     /// ```should_panic
 857     /// use std::cell::RefCell;
 858     ///
 859     /// let c = RefCell::new(5);
 860     /// let m = c.borrow();
 861     ///
 862     /// let b = c.borrow_mut(); // this causes a panic
 863     /// ```
 864     #[stable(feature = "rust1", since = "1.0.0")]
 865     #[inline]
 866     pub fn borrow_mut(&self) -> RefMut<'_, T> {
 867         self.try_borrow_mut().expect("already borrowed")
 868     }
 869
 870     /// Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
 871     ///
 872     /// The borrow lasts until the returned `RefMut` or all `RefMut`s derived
 873     /// from it exit scope. The value cannot be borrowed while this borrow is
 874     /// active.
 875     ///
 876     /// This is the non-panicking variant of [`borrow_mut`](#method.borrow_mut).
 877     ///
 878     /// # Examples
 879     ///
 880     /// ```
 881     /// use std::cell::RefCell;
 882     ///
 883     /// let c = RefCell::new(5);
 884     ///
 885     /// {
 886     ///     let m = c.borrow();
 887     ///     assert!(c.try_borrow_mut().is_err());
 888     /// }
 889     ///
 890     /// assert!(c.try_borrow_mut().is_ok());
 891     /// ```
 892     #[stable(feature = "try_borrow", since = "1.13.0")]
 893     #[inline]
 894     pub fn try_borrow_mut(&self) -> Result<RefMut<'_, T>, BorrowMutError> {
 895         match BorrowRefMut::new(&self.borrow) {
 896             // SAFETY: `BorrowRef` guarantees unique access.
 897             Some(b) => Ok(RefMut { value: unsafe { &mut *self.value.get() }, borrow: b }),
 898             None => Err(BorrowMutError { _private: () }),
 899         }
 900     }
 901
 902     /// Returns a raw pointer to the underlying data in this cell.
 903     ///
 904     /// # Examples
 905     ///
 906     /// ```
 907     /// use std::cell::RefCell;
 908     ///
 909     /// let c = RefCell::new(5);
 910     ///
 911     /// let ptr = c.as_ptr();
 912     /// ```
 913     #[inline]
 914     #[stable(feature = "cell_as_ptr", since = "1.12.0")]
 915     pub fn as_ptr(&self) -> *mut T {
 916         self.value.get()
 917     }
 918
 919     /// Returns a mutable reference to the underlying data.
 920     ///
 921     /// This call borrows `RefCell` mutably (at compile-time) so there is no
 922     /// need for dynamic checks.
 923     ///
 924     /// However be cautious: this method expects `self` to be mutable, which is
 925     /// generally not the case when using a `RefCell`. Take a look at the
 926     /// [`borrow_mut`] method instead if `self` isn't mutable.
 927     ///
 928     /// Also, please be aware that this method is only for special circumstances and is usually
 929     /// not what you want. In case of doubt, use [`borrow_mut`] instead.
 930     ///
 931     /// [`borrow_mut`]: #method.borrow_mut
 932     ///
 933     /// # Examples
 934     ///
 935     /// ```
 936     /// use std::cell::RefCell;
 937     ///
 938     /// let mut c = RefCell::new(5);
 939     /// *c.get_mut() += 1;
 940     ///
 941     /// assert_eq!(c, RefCell::new(6));
 942     /// ```
 943     #[inline]
 944     #[stable(feature = "cell_get_mut", since = "1.11.0")]
 945     pub fn get_mut(&mut self) -> &mut T {
 946         // SAFETY: `&mut` guarantees unique access.
 947         unsafe { &mut *self.value.get() }
 948     }
 949
 950     /// Undo the effect of leaked guards on the borrow state of the `RefCell`.
 951     ///
 952     /// This call is similar to [`get_mut`] but more specialized. It borrows `RefCell` mutably to
 953     /// ensure no borrows exist and then resets the state tracking shared borrows. This is relevant
 954     /// if some `Ref` or `RefMut` borrows have been leaked.
 955     ///
 956     /// [`get_mut`]: #method.get_mut
 957     ///
 958     /// # Examples
 959     ///
 960     /// ```
 961     /// #![feature(cell_leak)]
 962     /// use std::cell::RefCell;
 963     ///
 964     /// let mut c = RefCell::new(0);
 965     /// std::mem::forget(c.borrow_mut());
 966     ///
 967     /// assert!(c.try_borrow().is_err());
 968     /// c.undo_leak();
 969     /// assert!(c.try_borrow().is_ok());
 970     /// ```
 971     #[unstable(feature = "cell_leak", issue = "69099")]
 972     pub fn undo_leak(&mut self) -> &mut T {
 973         *self.borrow.get_mut() = UNUSED;
 974         self.get_mut()
 975     }
 976
 977     /// Immutably borrows the wrapped value, returning an error if the value is
 978     /// currently mutably borrowed.
 979     ///
 980     /// # Safety
 981     ///
 982     /// Unlike `RefCell::borrow`, this method is unsafe because it does not
 983     /// return a `Ref`, thus leaving the borrow flag untouched. Mutably
 984     /// borrowing the `RefCell` while the reference returned by this method
 985     /// is alive is undefined behaviour.
 986     ///
 987     /// # Examples
 988     ///
 989     /// ```
 990     /// use std::cell::RefCell;
 991     ///
 992     /// let c = RefCell::new(5);
 993     ///
 994     /// {
 995     ///     let m = c.borrow_mut();
 996     ///     assert!(unsafe { c.try_borrow_unguarded() }.is_err());
 997     /// }
 998     ///
 999     /// {
1000     ///     let m = c.borrow();
1001     ///     assert!(unsafe { c.try_borrow_unguarded() }.is_ok());
1002     /// }
1003     /// ```
1004     #[stable(feature = "borrow_state", since = "1.37.0")]
1005     #[inline]
1006     pub unsafe fn try_borrow_unguarded(&self) -> Result<&T, BorrowError> {
1007         if !is_writing(self.borrow.get()) {
1008             // SAFETY: We check that nobody is actively writing now, but it is
1009             // the caller's responsibility to ensure that nobody writes until
1010             // the returned reference is no longer in use.
1011             // Also, `self.value.get()` refers to the value owned by `self`
1012             // and is thus guaranteed to be valid for the lifetime of `self`.
1013             Ok(unsafe { &*self.value.get() })
1014         } else {
1015             Err(BorrowError { _private: () })
1016         }
1017     }
1018 }
1019
1020 impl<T: Default> RefCell<T> {
1021     /// Takes the wrapped value, leaving `Default::default()` in its place.
1022     ///
1023     /// # Panics
1024     ///
1025     /// Panics if the value is currently borrowed.
1026     ///
1027     /// # Examples
1028     ///
1029     /// ```
1030     /// #![feature(refcell_take)]
1031     /// use std::cell::RefCell;
1032     ///
1033     /// let c = RefCell::new(5);
1034     /// let five = c.take();
1035     ///
1036     /// assert_eq!(five, 5);
1037     /// assert_eq!(c.into_inner(), 0);
1038     /// ```
1039     #[unstable(feature = "refcell_take", issue = "71395")]
1040     pub fn take(&self) -> T {
1041         self.replace(Default::default())
1042     }
1043 }
1044
1045 #[stable(feature = "rust1", since = "1.0.0")]
1046 unsafe impl<T: ?Sized> Send for RefCell<T> where T: Send {}
1047
1048 #[stable(feature = "rust1", since = "1.0.0")]
1049 impl<T: ?Sized> !Sync for RefCell<T> {}
1050
1051 #[stable(feature = "rust1", since = "1.0.0")]
1052 impl<T: Clone> Clone for RefCell<T> {
1053     /// # Panics
1054     ///
1055     /// Panics if the value is currently mutably borrowed.
1056     #[inline]
1057     fn clone(&self) -> RefCell<T> {
1058         RefCell::new(self.borrow().clone())
1059     }
1060 }
1061
1062 #[stable(feature = "rust1", since = "1.0.0")]
1063 impl<T: Default> Default for RefCell<T> {
1064     /// Creates a `RefCell<T>`, with the `Default` value for T.
1065     #[inline]
1066     fn default() -> RefCell<T> {
1067         RefCell::new(Default::default())
1068     }
1069 }
1070
1071 #[stable(feature = "rust1", since = "1.0.0")]
1072 impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> {
1073     /// # Panics
1074     ///
1075     /// Panics if the value in either `RefCell` is currently borrowed.
1076     #[inline]
1077     fn eq(&self, other: &RefCell<T>) -> bool {
1078         *self.borrow() == *other.borrow()
1079     }
1080 }
1081
1082 #[stable(feature = "cell_eq", since = "1.2.0")]
1083 impl<T: ?Sized + Eq> Eq for RefCell<T> {}
1084
1085 #[stable(feature = "cell_ord", since = "1.10.0")]
1086 impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
1087     /// # Panics
1088     ///
1089     /// Panics if the value in either `RefCell` is currently borrowed.
1090     #[inline]
1091     fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> {
1092         self.borrow().partial_cmp(&*other.borrow())
1093     }
1094
1095     /// # Panics
1096     ///
1097     /// Panics if the value in either `RefCell` is currently borrowed.
1098     #[inline]
1099     fn lt(&self, other: &RefCell<T>) -> bool {
1100         *self.borrow() < *other.borrow()
1101     }
1102
1103     /// # Panics
1104     ///
1105     /// Panics if the value in either `RefCell` is currently borrowed.
1106     #[inline]
1107     fn le(&self, other: &RefCell<T>) -> bool {
1108         *self.borrow() <= *other.borrow()
1109     }
1110
1111     /// # Panics
1112     ///
1113     /// Panics if the value in either `RefCell` is currently borrowed.
1114     #[inline]
1115     fn gt(&self, other: &RefCell<T>) -> bool {
1116         *self.borrow() > *other.borrow()
1117     }
1118
1119     /// # Panics
1120     ///
1121     /// Panics if the value in either `RefCell` is currently borrowed.
1122     #[inline]
1123     fn ge(&self, other: &RefCell<T>) -> bool {
1124         *self.borrow() >= *other.borrow()
1125     }
1126 }
1127
1128 #[stable(feature = "cell_ord", since = "1.10.0")]
1129 impl<T: ?Sized + Ord> Ord for RefCell<T> {
1130     /// # Panics
1131     ///
1132     /// Panics if the value in either `RefCell` is currently borrowed.
1133     #[inline]
1134     fn cmp(&self, other: &RefCell<T>) -> Ordering {
1135         self.borrow().cmp(&*other.borrow())
1136     }
1137 }
1138
1139 #[stable(feature = "cell_from", since = "1.12.0")]
1140 impl<T> From<T> for RefCell<T> {
1141     fn from(t: T) -> RefCell<T> {
1142         RefCell::new(t)
1143     }
1144 }
1145
1146 #[unstable(feature = "coerce_unsized", issue = "27732")]
1147 impl<T: CoerceUnsized<U>, U> CoerceUnsized<RefCell<U>> for RefCell<T> {}
1148
1149 struct BorrowRef<'b> {
1150     borrow: &'b Cell<BorrowFlag>,
1151 }
1152
1153 impl<'b> BorrowRef<'b> {
1154     #[inline]
1155     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRef<'b>> {
1156         let b = borrow.get().wrapping_add(1);
1157         if !is_reading(b) {
1158             // Incrementing borrow can result in a non-reading value (<= 0) in these cases:
1159             // 1. It was < 0, i.e. there are writing borrows, so we can't allow a read borrow
1160             //    due to Rust's reference aliasing rules
1161             // 2. It was isize::MAX (the max amount of reading borrows) and it overflowed
1162             //    into isize::MIN (the max amount of writing borrows) so we can't allow
1163             //    an additional read borrow because isize can't represent so many read borrows
1164             //    (this can only happen if you mem::forget more than a small constant amount of
1165             //    `Ref`s, which is not good practice)
1166             None
1167         } else {
1168             // Incrementing borrow can result in a reading value (> 0) in these cases:
1169             // 1. It was = 0, i.e. it wasn't borrowed, and we are taking the first read borrow
1170             // 2. It was > 0 and < isize::MAX, i.e. there were read borrows, and isize
1171             //    is large enough to represent having one more read borrow
1172             borrow.set(b);
1173             Some(BorrowRef { borrow })
1174         }
1175     }
1176 }
1177
1178 impl Drop for BorrowRef<'_> {
1179     #[inline]
1180     fn drop(&mut self) {
1181         let borrow = self.borrow.get();
1182         debug_assert!(is_reading(borrow));
1183         self.borrow.set(borrow - 1);
1184     }
1185 }
1186
1187 impl Clone for BorrowRef<'_> {
1188     #[inline]
1189     fn clone(&self) -> Self {
1190         // Since this Ref exists, we know the borrow flag
1191         // is a reading borrow.
1192         let borrow = self.borrow.get();
1193         debug_assert!(is_reading(borrow));
1194         // Prevent the borrow counter from overflowing into
1195         // a writing borrow.
1196         assert!(borrow != isize::MAX);
1197         self.borrow.set(borrow + 1);
1198         BorrowRef { borrow: self.borrow }
1199     }
1200 }
1201
1202 /// Wraps a borrowed reference to a value in a `RefCell` box.
1203 /// A wrapper type for an immutably borrowed value from a `RefCell<T>`.
1204 ///
1205 /// See the [module-level documentation](index.html) for more.
1206 #[stable(feature = "rust1", since = "1.0.0")]
1207 pub struct Ref<'b, T: ?Sized + 'b> {
1208     value: &'b T,
1209     borrow: BorrowRef<'b>,
1210 }
1211
1212 #[stable(feature = "rust1", since = "1.0.0")]
1213 impl<T: ?Sized> Deref for Ref<'_, T> {
1214     type Target = T;
1215
1216     #[inline]
1217     fn deref(&self) -> &T {
1218         self.value
1219     }
1220 }
1221
1222 impl<'b, T: ?Sized> Ref<'b, T> {
1223     /// Copies a `Ref`.
1224     ///
1225     /// The `RefCell` is already immutably borrowed, so this cannot fail.
1226     ///
1227     /// This is an associated function that needs to be used as
1228     /// `Ref::clone(...)`. A `Clone` implementation or a method would interfere
1229     /// with the widespread use of `r.borrow().clone()` to clone the contents of
1230     /// a `RefCell`.
1231     #[stable(feature = "cell_extras", since = "1.15.0")]
1232     #[inline]
1233     pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> {
1234         Ref { value: orig.value, borrow: orig.borrow.clone() }
1235     }
1236
1237     /// Makes a new `Ref` for a component of the borrowed data.
1238     ///
1239     /// The `RefCell` is already immutably borrowed, so this cannot fail.
1240     ///
1241     /// This is an associated function that needs to be used as `Ref::map(...)`.
1242     /// A method would interfere with methods of the same name on the contents
1243     /// of a `RefCell` used through `Deref`.
1244     ///
1245     /// # Examples
1246     ///
1247     /// ```
1248     /// use std::cell::{RefCell, Ref};
1249     ///
1250     /// let c = RefCell::new((5, 'b'));
1251     /// let b1: Ref<(u32, char)> = c.borrow();
1252     /// let b2: Ref<u32> = Ref::map(b1, |t| &t.0);
1253     /// assert_eq!(*b2, 5)
1254     /// ```
1255     #[stable(feature = "cell_map", since = "1.8.0")]
1256     #[inline]
1257     pub fn map<U: ?Sized, F>(orig: Ref<'b, T>, f: F) -> Ref<'b, U>
1258     where
1259         F: FnOnce(&T) -> &U,
1260     {
1261         Ref { value: f(orig.value), borrow: orig.borrow }
1262     }
1263
1264     /// Splits a `Ref` into multiple `Ref`s for different components of the
1265     /// borrowed data.
1266     ///
1267     /// The `RefCell` is already immutably borrowed, so this cannot fail.
1268     ///
1269     /// This is an associated function that needs to be used as
1270     /// `Ref::map_split(...)`. A method would interfere with methods of the same
1271     /// name on the contents of a `RefCell` used through `Deref`.
1272     ///
1273     /// # Examples
1274     ///
1275     /// ```
1276     /// use std::cell::{Ref, RefCell};
1277     ///
1278     /// let cell = RefCell::new([1, 2, 3, 4]);
1279     /// let borrow = cell.borrow();
1280     /// let (begin, end) = Ref::map_split(borrow, |slice| slice.split_at(2));
1281     /// assert_eq!(*begin, [1, 2]);
1282     /// assert_eq!(*end, [3, 4]);
1283     /// ```
1284     #[stable(feature = "refcell_map_split", since = "1.35.0")]
1285     #[inline]
1286     pub fn map_split<U: ?Sized, V: ?Sized, F>(orig: Ref<'b, T>, f: F) -> (Ref<'b, U>, Ref<'b, V>)
1287     where
1288         F: FnOnce(&T) -> (&U, &V),
1289     {
1290         let (a, b) = f(orig.value);
1291         let borrow = orig.borrow.clone();
1292         (Ref { value: a, borrow }, Ref { value: b, borrow: orig.borrow })
1293     }
1294
1295     /// Convert into a reference to the underlying data.
1296     ///
1297     /// The underlying `RefCell` can never be mutably borrowed from again and will always appear
1298     /// already immutably borrowed. It is not a good idea to leak more than a constant number of
1299     /// references. The `RefCell` can be immutably borrowed again if only a smaller number of leaks
1300     /// have occurred in total.
1301     ///
1302     /// This is an associated function that needs to be used as
1303     /// `Ref::leak(...)`. A method would interfere with methods of the
1304     /// same name on the contents of a `RefCell` used through `Deref`.
1305     ///
1306     /// # Examples
1307     ///
1308     /// ```
1309     /// #![feature(cell_leak)]
1310     /// use std::cell::{RefCell, Ref};
1311     /// let cell = RefCell::new(0);
1312     ///
1313     /// let value = Ref::leak(cell.borrow());
1314     /// assert_eq!(*value, 0);
1315     ///
1316     /// assert!(cell.try_borrow().is_ok());
1317     /// assert!(cell.try_borrow_mut().is_err());
1318     /// ```
1319     #[unstable(feature = "cell_leak", issue = "69099")]
1320     pub fn leak(orig: Ref<'b, T>) -> &'b T {
1321         // By forgetting this Ref we ensure that the borrow counter in the RefCell can't go back to
1322         // UNUSED within the lifetime `'b`. Resetting the reference tracking state would require a
1323         // unique reference to the borrowed RefCell. No further mutable references can be created
1324         // from the original cell.
1325         mem::forget(orig.borrow);
1326         orig.value
1327     }
1328 }
1329
1330 #[unstable(feature = "coerce_unsized", issue = "27732")]
1331 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Ref<'b, U>> for Ref<'b, T> {}
1332
1333 #[stable(feature = "std_guard_impls", since = "1.20.0")]
1334 impl<T: ?Sized + fmt::Display> fmt::Display for Ref<'_, T> {
1335     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1336         self.value.fmt(f)
1337     }
1338 }
1339
1340 impl<'b, T: ?Sized> RefMut<'b, T> {
1341     /// Makes a new `RefMut` for a component of the borrowed data, e.g., an enum
1342     /// variant.
1343     ///
1344     /// The `RefCell` is already mutably borrowed, so this cannot fail.
1345     ///
1346     /// This is an associated function that needs to be used as
1347     /// `RefMut::map(...)`. A method would interfere with methods of the same
1348     /// name on the contents of a `RefCell` used through `Deref`.
1349     ///
1350     /// # Examples
1351     ///
1352     /// ```
1353     /// use std::cell::{RefCell, RefMut};
1354     ///
1355     /// let c = RefCell::new((5, 'b'));
1356     /// {
1357     ///     let b1: RefMut<(u32, char)> = c.borrow_mut();
1358     ///     let mut b2: RefMut<u32> = RefMut::map(b1, |t| &mut t.0);
1359     ///     assert_eq!(*b2, 5);
1360     ///     *b2 = 42;
1361     /// }
1362     /// assert_eq!(*c.borrow(), (42, 'b'));
1363     /// ```
1364     #[stable(feature = "cell_map", since = "1.8.0")]
1365     #[inline]
1366     pub fn map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> RefMut<'b, U>
1367     where
1368         F: FnOnce(&mut T) -> &mut U,
1369     {
1370         // FIXME(nll-rfc#40): fix borrow-check
1371         let RefMut { value, borrow } = orig;
1372         RefMut { value: f(value), borrow }
1373     }
1374
1375     /// Splits a `RefMut` into multiple `RefMut`s for different components of the
1376     /// borrowed data.
1377     ///
1378     /// The underlying `RefCell` will remain mutably borrowed until both
1379     /// returned `RefMut`s go out of scope.
1380     ///
1381     /// The `RefCell` is already mutably borrowed, so this cannot fail.
1382     ///
1383     /// This is an associated function that needs to be used as
1384     /// `RefMut::map_split(...)`. A method would interfere with methods of the
1385     /// same name on the contents of a `RefCell` used through `Deref`.
1386     ///
1387     /// # Examples
1388     ///
1389     /// ```
1390     /// use std::cell::{RefCell, RefMut};
1391     ///
1392     /// let cell = RefCell::new([1, 2, 3, 4]);
1393     /// let borrow = cell.borrow_mut();
1394     /// let (mut begin, mut end) = RefMut::map_split(borrow, |slice| slice.split_at_mut(2));
1395     /// assert_eq!(*begin, [1, 2]);
1396     /// assert_eq!(*end, [3, 4]);
1397     /// begin.copy_from_slice(&[4, 3]);
1398     /// end.copy_from_slice(&[2, 1]);
1399     /// ```
1400     #[stable(feature = "refcell_map_split", since = "1.35.0")]
1401     #[inline]
1402     pub fn map_split<U: ?Sized, V: ?Sized, F>(
1403         orig: RefMut<'b, T>,
1404         f: F,
1405     ) -> (RefMut<'b, U>, RefMut<'b, V>)
1406     where
1407         F: FnOnce(&mut T) -> (&mut U, &mut V),
1408     {
1409         let (a, b) = f(orig.value);
1410         let borrow = orig.borrow.clone();
1411         (RefMut { value: a, borrow }, RefMut { value: b, borrow: orig.borrow })
1412     }
1413
1414     /// Convert into a mutable reference to the underlying data.
1415     ///
1416     /// The underlying `RefCell` can not be borrowed from again and will always appear already
1417     /// mutably borrowed, making the returned reference the only to the interior.
1418     ///
1419     /// This is an associated function that needs to be used as
1420     /// `RefMut::leak(...)`. A method would interfere with methods of the
1421     /// same name on the contents of a `RefCell` used through `Deref`.
1422     ///
1423     /// # Examples
1424     ///
1425     /// ```
1426     /// #![feature(cell_leak)]
1427     /// use std::cell::{RefCell, RefMut};
1428     /// let cell = RefCell::new(0);
1429     ///
1430     /// let value = RefMut::leak(cell.borrow_mut());
1431     /// assert_eq!(*value, 0);
1432     /// *value = 1;
1433     ///
1434     /// assert!(cell.try_borrow_mut().is_err());
1435     /// ```
1436     #[unstable(feature = "cell_leak", issue = "69099")]
1437     pub fn leak(orig: RefMut<'b, T>) -> &'b mut T {
1438         // By forgetting this BorrowRefMut we ensure that the borrow counter in the RefCell can't
1439         // go back to UNUSED within the lifetime `'b`. Resetting the reference tracking state would
1440         // require a unique reference to the borrowed RefCell. No further references can be created
1441         // from the original cell within that lifetime, making the current borrow the only
1442         // reference for the remaining lifetime.
1443         mem::forget(orig.borrow);
1444         orig.value
1445     }
1446 }
1447
1448 struct BorrowRefMut<'b> {
1449     borrow: &'b Cell<BorrowFlag>,
1450 }
1451
1452 impl Drop for BorrowRefMut<'_> {
1453     #[inline]
1454     fn drop(&mut self) {
1455         let borrow = self.borrow.get();
1456         debug_assert!(is_writing(borrow));
1457         self.borrow.set(borrow + 1);
1458     }
1459 }
1460
1461 impl<'b> BorrowRefMut<'b> {
1462     #[inline]
1463     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRefMut<'b>> {
1464         // NOTE: Unlike BorrowRefMut::clone, new is called to create the initial
1465         // mutable reference, and so there must currently be no existing
1466         // references. Thus, while clone increments the mutable refcount, here
1467         // we explicitly only allow going from UNUSED to UNUSED - 1.
1468         match borrow.get() {
1469             UNUSED => {
1470                 borrow.set(UNUSED - 1);
1471                 Some(BorrowRefMut { borrow })
1472             }
1473             _ => None,
1474         }
1475     }
1476
1477     // Clones a `BorrowRefMut`.
1478     //
1479     // This is only valid if each `BorrowRefMut` is used to track a mutable
1480     // reference to a distinct, nonoverlapping range of the original object.
1481     // This isn't in a Clone impl so that code doesn't call this implicitly.
1482     #[inline]
1483     fn clone(&self) -> BorrowRefMut<'b> {
1484         let borrow = self.borrow.get();
1485         debug_assert!(is_writing(borrow));
1486         // Prevent the borrow counter from underflowing.
1487         assert!(borrow != isize::MIN);
1488         self.borrow.set(borrow - 1);
1489         BorrowRefMut { borrow: self.borrow }
1490     }
1491 }
1492
1493 /// A wrapper type for a mutably borrowed value from a `RefCell<T>`.
1494 ///
1495 /// See the [module-level documentation](index.html) for more.
1496 #[stable(feature = "rust1", since = "1.0.0")]
1497 pub struct RefMut<'b, T: ?Sized + 'b> {
1498     value: &'b mut T,
1499     borrow: BorrowRefMut<'b>,
1500 }
1501
1502 #[stable(feature = "rust1", since = "1.0.0")]
1503 impl<T: ?Sized> Deref for RefMut<'_, T> {
1504     type Target = T;
1505
1506     #[inline]
1507     fn deref(&self) -> &T {
1508         self.value
1509     }
1510 }
1511
1512 #[stable(feature = "rust1", since = "1.0.0")]
1513 impl<T: ?Sized> DerefMut for RefMut<'_, T> {
1514     #[inline]
1515     fn deref_mut(&mut self) -> &mut T {
1516         self.value
1517     }
1518 }
1519
1520 #[unstable(feature = "coerce_unsized", issue = "27732")]
1521 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<RefMut<'b, U>> for RefMut<'b, T> {}
1522
1523 #[stable(feature = "std_guard_impls", since = "1.20.0")]
1524 impl<T: ?Sized + fmt::Display> fmt::Display for RefMut<'_, T> {
1525     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1526         self.value.fmt(f)
1527     }
1528 }
1529
1530 /// The core primitive for interior mutability in Rust.
1531 ///
1532 /// `UnsafeCell<T>` is a type that wraps some `T` and indicates unsafe interior operations on the
1533 /// wrapped type. Types with an `UnsafeCell<T>` field are considered to have an 'unsafe interior'.
1534 /// The `UnsafeCell<T>` type is the only legal way to obtain aliasable data that is considered
1535 /// mutable. In general, transmuting an `&T` type into an `&mut T` is considered undefined behavior.
1536 ///
1537 /// If you have a reference `&SomeStruct`, then normally in Rust all fields of `SomeStruct` are
1538 /// immutable. The compiler makes optimizations based on the knowledge that `&T` is not mutably
1539 /// aliased or mutated, and that `&mut T` is unique. `UnsafeCell<T>` is the only core language
1540 /// feature to work around the restriction that `&T` may not be mutated. All other types that
1541 /// allow internal mutability, such as `Cell<T>` and `RefCell<T>`, use `UnsafeCell` to wrap their
1542 /// internal data. There is *no* legal way to obtain aliasing `&mut`, not even with `UnsafeCell<T>`.
1543 ///
1544 /// The `UnsafeCell` API itself is technically very simple: it gives you a raw pointer `*mut T` to
1545 /// its contents. It is up to _you_ as the abstraction designer to use that raw pointer correctly.
1546 ///
1547 /// The precise Rust aliasing rules are somewhat in flux, but the main points are not contentious:
1548 ///
1549 /// - If you create a safe reference with lifetime `'a` (either a `&T` or `&mut T`
1550 /// reference) that is accessible by safe code (for example, because you returned it),
1551 /// then you must not access the data in any way that contradicts that reference for the
1552 /// remainder of `'a`. For example, this means that if you take the `*mut T` from an
1553 /// `UnsafeCell<T>` and cast it to an `&T`, then the data in `T` must remain immutable
1554 /// (modulo any `UnsafeCell` data found within `T`, of course) until that reference's
1555 /// lifetime expires. Similarly, if you create a `&mut T` reference that is released to
1556 /// safe code, then you must not access the data within the `UnsafeCell` until that
1557 /// reference expires.
1558 ///
1559 /// - At all times, you must avoid data races. If multiple threads have access to
1560 /// the same `UnsafeCell`, then any writes must have a proper happens-before relation to all other
1561 /// accesses (or use atomics).
1562 ///
1563 /// To assist with proper design, the following scenarios are explicitly declared legal
1564 /// for single-threaded code:
1565 ///
1566 /// 1. A `&T` reference can be released to safe code and there it can co-exist with other `&T`
1567 /// references, but not with a `&mut T`
1568 ///
1569 /// 2. A `&mut T` reference may be released to safe code provided neither other `&mut T` nor `&T`
1570 /// co-exist with it. A `&mut T` must always be unique.
1571 ///
1572 /// Note that while mutating or mutably aliasing the contents of an `&UnsafeCell<T>` is
1573 /// ok (provided you enforce the invariants some other way), it is still undefined behavior
1574 /// to have multiple `&mut UnsafeCell<T>` aliases.
1575 ///
1576 /// # Examples
1577 ///
1578 /// ```
1579 /// use std::cell::UnsafeCell;
1580 ///
1581 /// # #[allow(dead_code)]
1582 /// struct NotThreadSafe<T> {
1583 ///     value: UnsafeCell<T>,
1584 /// }
1585 ///
1586 /// unsafe impl<T> Sync for NotThreadSafe<T> {}
1587 /// ```
1588 #[lang = "unsafe_cell"]
1589 #[stable(feature = "rust1", since = "1.0.0")]
1590 #[repr(transparent)]
1591 #[repr(no_niche)] // rust-lang/rust#68303.
1592 pub struct UnsafeCell<T: ?Sized> {
1593     value: T,
1594 }
1595
1596 #[stable(feature = "rust1", since = "1.0.0")]
1597 impl<T: ?Sized> !Sync for UnsafeCell<T> {}
1598
1599 impl<T> UnsafeCell<T> {
1600     /// Constructs a new instance of `UnsafeCell` which will wrap the specified
1601     /// value.
1602     ///
1603     /// All access to the inner value through methods is `unsafe`.
1604     ///
1605     /// # Examples
1606     ///
1607     /// ```
1608     /// use std::cell::UnsafeCell;
1609     ///
1610     /// let uc = UnsafeCell::new(5);
1611     /// ```
1612     #[stable(feature = "rust1", since = "1.0.0")]
1613     #[rustc_const_stable(feature = "const_unsafe_cell_new", since = "1.32.0")]
1614     #[inline]
1615     pub const fn new(value: T) -> UnsafeCell<T> {
1616         UnsafeCell { value }
1617     }
1618
1619     /// Unwraps the value.
1620     ///
1621     /// # Examples
1622     ///
1623     /// ```
1624     /// use std::cell::UnsafeCell;
1625     ///
1626     /// let uc = UnsafeCell::new(5);
1627     ///
1628     /// let five = uc.into_inner();
1629     /// ```
1630     #[inline]
1631     #[stable(feature = "rust1", since = "1.0.0")]
1632     pub fn into_inner(self) -> T {
1633         self.value
1634     }
1635 }
1636
1637 impl<T: ?Sized> UnsafeCell<T> {
1638     /// Gets a mutable pointer to the wrapped value.
1639     ///
1640     /// This can be cast to a pointer of any kind.
1641     /// Ensure that the access is unique (no active references, mutable or not)
1642     /// when casting to `&mut T`, and ensure that there are no mutations
1643     /// or mutable aliases going on when casting to `&T`
1644     ///
1645     /// # Examples
1646     ///
1647     /// ```
1648     /// use std::cell::UnsafeCell;
1649     ///
1650     /// let uc = UnsafeCell::new(5);
1651     ///
1652     /// let five = uc.get();
1653     /// ```
1654     #[inline]
1655     #[stable(feature = "rust1", since = "1.0.0")]
1656     #[rustc_const_stable(feature = "const_unsafecell_get", since = "1.32.0")]
1657     pub const fn get(&self) -> *mut T {
1658         // We can just cast the pointer from `UnsafeCell<T>` to `T` because of
1659         // #[repr(transparent)]. This exploits libstd's special status, there is
1660         // no guarantee for user code that this will work in future versions of the compiler!
1661         self as *const UnsafeCell<T> as *const T as *mut T
1662     }
1663
1664     /// Gets a mutable pointer to the wrapped value.
1665     /// The difference to [`get`] is that this function accepts a raw pointer,
1666     /// which is useful to avoid the creation of temporary references.
1667     ///
1668     /// The result can be cast to a pointer of any kind.
1669     /// Ensure that the access is unique (no active references, mutable or not)
1670     /// when casting to `&mut T`, and ensure that there are no mutations
1671     /// or mutable aliases going on when casting to `&T`.
1672     ///
1673     /// [`get`]: #method.get
1674     ///
1675     /// # Examples
1676     ///
1677     /// Gradual initialization of an `UnsafeCell` requires `raw_get`, as
1678     /// calling `get` would require creating a reference to uninitialized data:
1679     ///
1680     /// ```
1681     /// #![feature(unsafe_cell_raw_get)]
1682     /// use std::cell::UnsafeCell;
1683     /// use std::mem::MaybeUninit;
1684     ///
1685     /// let m = MaybeUninit::<UnsafeCell<i32>>::uninit();
1686     /// unsafe { UnsafeCell::raw_get(m.as_ptr()).write(5); }
1687     /// let uc = unsafe { m.assume_init() };
1688     ///
1689     /// assert_eq!(uc.into_inner(), 5);
1690     /// ```
1691     #[inline]
1692     #[unstable(feature = "unsafe_cell_raw_get", issue = "66358")]
1693     pub const fn raw_get(this: *const Self) -> *mut T {
1694         // We can just cast the pointer from `UnsafeCell<T>` to `T` because of
1695         // #[repr(transparent)]. This exploits libstd's special status, there is
1696         // no guarantee for user code that this will work in future versions of the compiler!
1697         this as *const T as *mut T
1698     }
1699 }
1700
1701 #[stable(feature = "unsafe_cell_default", since = "1.10.0")]
1702 impl<T: Default> Default for UnsafeCell<T> {
1703     /// Creates an `UnsafeCell`, with the `Default` value for T.
1704     fn default() -> UnsafeCell<T> {
1705         UnsafeCell::new(Default::default())
1706     }
1707 }
1708
1709 #[stable(feature = "cell_from", since = "1.12.0")]
1710 impl<T> From<T> for UnsafeCell<T> {
1711     fn from(t: T) -> UnsafeCell<T> {
1712         UnsafeCell::new(t)
1713     }
1714 }
1715
1716 #[unstable(feature = "coerce_unsized", issue = "27732")]
1717 impl<T: CoerceUnsized<U>, U> CoerceUnsized<UnsafeCell<U>> for UnsafeCell<T> {}
1718
1719 #[allow(unused)]
1720 fn assert_coerce_unsized(a: UnsafeCell<&i32>, b: Cell<&i32>, c: RefCell<&i32>) {
1721     let _: UnsafeCell<&dyn Send> = a;
1722     let _: Cell<&dyn Send> = b;
1723     let _: RefCell<&dyn Send> = c;
1724 }