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