src/libcore/cell.rs

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