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