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 //! Values of the `Cell<T>` and `RefCell<T>` types may be mutated through shared references (i.e.
  14 //! the common `&T` type), whereas most Rust types can only be mutated through unique (`&mut T`)
  15 //! references. We say that `Cell<T>` and `RefCell<T>` provide 'interior mutability', in contrast
  16 //! with typical Rust types that exhibit 'inherited mutability'.
  17 //!
  18 //! Cell types come in two flavors: `Cell<T>` and `RefCell<T>`. `Cell<T>` implements interior
  19 //! mutability by moving values in and out of the `Cell<T>`. To use references instead of values,
  20 //! one must use the `RefCell<T>` type, acquiring a write lock before mutating. `Cell<T>` provides
  21 //! methods to retrieve and change the current interior value:
  22 //!
  23 //!  - For types that implement `Copy`, the `get` method retrieves the current interior value.
  24 //!  - For types that implement `Default`, the `take` method replaces the current interior value
  25 //!    with `Default::default()` and returns the replaced value.
  26 //!  - For all types, the `replace` method replaces the current interior value and returns the
  27 //!    replaced value and the `into_inner` method consumes the `Cell<T>` and returns the interior
  28 //!    value. Additionally, the `set` method replaces the interior value, dropping the replaced
  29 //!    value.
  30 //!
  31 //! `RefCell<T>` uses Rust's lifetimes to implement 'dynamic borrowing', a process whereby one can
  32 //! claim temporary, exclusive, mutable access to the inner value. Borrows for `RefCell<T>`s are
  33 //! tracked 'at runtime', unlike Rust's native reference types which are entirely tracked
  34 //! statically, at compile time. Because `RefCell<T>` borrows are dynamic it is possible to attempt
  35 //! to borrow a value that is already mutably borrowed; when this happens it results in thread
  36 //! panic.
  37 //!
  38 //! # When to choose interior mutability
  39 //!
  40 //! The more common inherited mutability, where one must have unique access to mutate a value, is
  41 //! one of the key language elements that enables Rust to reason strongly about pointer aliasing,
  42 //! statically preventing crash bugs. Because of that, inherited mutability is preferred, and
  43 //! interior mutability is something of a last resort. Since cell types enable mutation where it
  44 //! would otherwise be disallowed though, there are occasions when interior mutability might be
  45 //! appropriate, or even *must* be used, e.g.
  46 //!
  47 //! * Introducing mutability 'inside' of something immutable
  48 //! * Implementation details of logically-immutable methods.
  49 //! * Mutating implementations of `Clone`.
  50 //!
  51 //! ## Introducing mutability 'inside' of something immutable
  52 //!
  53 //! Many shared smart pointer types, including `Rc<T>` and `Arc<T>`, provide containers that can be
  54 //! cloned and shared between multiple parties. Because the contained values may be
  55 //! multiply-aliased, they can only be borrowed with `&`, not `&mut`. Without cells it would be
  56 //! impossible to mutate data inside of these smart pointers at all.
  57 //!
  58 //! It's very common then to put a `RefCell<T>` inside shared pointer types to reintroduce
  59 //! mutability:
  60 //!
  61 //! ```
  62 //! use std::collections::HashMap;
  63 //! use std::cell::RefCell;
  64 //! use std::rc::Rc;
  65 //!
  66 //! fn main() {
  67 //!     let shared_map: Rc<RefCell<_>> = Rc::new(RefCell::new(HashMap::new()));
  68 //!     shared_map.borrow_mut().insert("africa", 92388);
  69 //!     shared_map.borrow_mut().insert("kyoto", 11837);
  70 //!     shared_map.borrow_mut().insert("piccadilly", 11826);
  71 //!     shared_map.borrow_mut().insert("marbles", 38);
  72 //! }
  73 //! ```
  74 //!
  75 //! Note that this example uses `Rc<T>` and not `Arc<T>`. `RefCell<T>`s are for single-threaded
  76 //! scenarios. Consider using `RwLock<T>` or `Mutex<T>` if you need shared mutability in a
  77 //! multi-threaded situation.
  78 //!
  79 //! ## Implementation details of logically-immutable methods
  80 //!
  81 //! Occasionally it may be desirable not to expose in an API that there is mutation happening
  82 //! "under the hood". This may be because logically the operation is immutable, but e.g. caching
  83 //! forces the implementation to perform mutation; or because you must employ mutation to implement
  84 //! a trait method that was originally defined to take `&self`.
  85 //!
  86 //! ```
  87 //! # #![allow(dead_code)]
  88 //! use std::cell::RefCell;
  89 //!
  90 //! struct Graph {
  91 //!     edges: Vec<(i32, i32)>,
  92 //!     span_tree_cache: RefCell<Option<Vec<(i32, i32)>>>
  93 //! }
  94 //!
  95 //! impl Graph {
  96 //!     fn minimum_spanning_tree(&self) -> Vec<(i32, i32)> {
  97 //!         // Create a new scope to contain the lifetime of the
  98 //!         // dynamic borrow
  99 //!         {
 100 //!             // Take a reference to the inside of cache cell
 101 //!             let mut cache = self.span_tree_cache.borrow_mut();
 102 //!             if cache.is_some() {
 103 //!                 return cache.as_ref().unwrap().clone();
 104 //!             }
 105 //!
 106 //!             let span_tree = self.calc_span_tree();
 107 //!             *cache = Some(span_tree);
 108 //!         }
 109 //!
 110 //!         // Recursive call to return the just-cached value.
 111 //!         // Note that if we had not let the previous borrow
 112 //!         // of the cache fall out of scope then the subsequent
 113 //!         // recursive borrow would cause a dynamic thread panic.
 114 //!         // This is the major hazard of using `RefCell`.
 115 //!         self.minimum_spanning_tree()
 116 //!     }
 117 //! #   fn calc_span_tree(&self) -> Vec<(i32, i32)> { vec![] }
 118 //! }
 119 //! ```
 120 //!
 121 //! ## Mutating implementations of `Clone`
 122 //!
 123 //! This is simply a special - but common - case of the previous: hiding mutability for operations
 124 //! that appear to be immutable. The `clone` method is expected to not change the source value, and
 125 //! is declared to take `&self`, not `&mut self`. Therefore any mutation that happens in the
 126 //! `clone` method must use cell types. For example, `Rc<T>` maintains its reference counts within a
 127 //! `Cell<T>`.
 128 //!
 129 //! ```
 130 //! #![feature(core_intrinsics)]
 131 //! #![feature(shared)]
 132 //! use std::cell::Cell;
 133 //! use std::ptr::Shared;
 134 //! use std::intrinsics::abort;
 135 //!
 136 //! struct Rc<T: ?Sized> {
 137 //!     ptr: Shared<RcBox<T>>
 138 //! }
 139 //!
 140 //! struct RcBox<T: ?Sized> {
 141 //!     strong: Cell<usize>,
 142 //!     refcount: Cell<usize>,
 143 //!     value: T,
 144 //! }
 145 //!
 146 //! impl<T: ?Sized> Clone for Rc<T> {
 147 //!     fn clone(&self) -> Rc<T> {
 148 //!         self.inc_strong();
 149 //!         Rc { ptr: self.ptr }
 150 //!     }
 151 //! }
 152 //!
 153 //! trait RcBoxPtr<T: ?Sized> {
 154 //!
 155 //!     fn inner(&self) -> &RcBox<T>;
 156 //!
 157 //!     fn strong(&self) -> usize {
 158 //!         self.inner().strong.get()
 159 //!     }
 160 //!
 161 //!     fn inc_strong(&self) {
 162 //!         self.inner()
 163 //!             .strong
 164 //!             .set(self.strong()
 165 //!                      .checked_add(1)
 166 //!                      .unwrap_or_else(|| unsafe { abort() }));
 167 //!     }
 168 //! }
 169 //!
 170 //! impl<T: ?Sized> RcBoxPtr<T> for Rc<T> {
 171 //!    fn inner(&self) -> &RcBox<T> {
 172 //!        unsafe {
 173 //!            self.ptr.as_ref()
 174 //!        }
 175 //!    }
 176 //! }
 177 //! ```
 178 //!
 179
 180 #![stable(feature = "rust1", since = "1.0.0")]
 181
 182 use cmp::Ordering;
 183 use fmt::{self, Debug, Display};
 184 use marker::Unsize;
 185 use mem;
 186 use ops::{Deref, DerefMut, CoerceUnsized};
 187 use ptr;
 188
 189 /// A mutable memory location.
 190 ///
 191 /// # Examples
 192 ///
 193 /// Here you can see how using `Cell<T>` allows to use mutable field inside
 194 /// immutable struct (which is also called 'interior mutability').
 195 ///
 196 /// ```
 197 /// use std::cell::Cell;
 198 ///
 199 /// struct SomeStruct {
 200 ///     regular_field: u8,
 201 ///     special_field: Cell<u8>,
 202 /// }
 203 ///
 204 /// let my_struct = SomeStruct {
 205 ///     regular_field: 0,
 206 ///     special_field: Cell::new(1),
 207 /// };
 208 ///
 209 /// let new_value = 100;
 210 ///
 211 /// // ERROR, because my_struct is immutable
 212 /// // my_struct.regular_field = new_value;
 213 ///
 214 /// // WORKS, although `my_struct` is immutable, field `special_field` is mutable because it is Cell
 215 /// my_struct.special_field.set(new_value);
 216 /// assert_eq!(my_struct.special_field.get(), new_value);
 217 /// ```
 218 ///
 219 /// See the [module-level documentation](index.html) for more.
 220 #[stable(feature = "rust1", since = "1.0.0")]
 221 pub struct Cell<T> {
 222     value: UnsafeCell<T>,
 223 }
 224
 225 impl<T:Copy> Cell<T> {
 226     /// Returns a copy of the contained value.
 227     ///
 228     /// # Examples
 229     ///
 230     /// ```
 231     /// use std::cell::Cell;
 232     ///
 233     /// let c = Cell::new(5);
 234     ///
 235     /// let five = c.get();
 236     /// ```
 237     #[inline]
 238     #[stable(feature = "rust1", since = "1.0.0")]
 239     pub fn get(&self) -> T {
 240         unsafe{ *self.value.get() }
 241     }
 242 }
 243
 244 #[stable(feature = "rust1", since = "1.0.0")]
 245 unsafe impl<T> Send for Cell<T> where T: Send {}
 246
 247 #[stable(feature = "rust1", since = "1.0.0")]
 248 impl<T> !Sync for Cell<T> {}
 249
 250 #[stable(feature = "rust1", since = "1.0.0")]
 251 impl<T:Copy> Clone for Cell<T> {
 252     #[inline]
 253     fn clone(&self) -> Cell<T> {
 254         Cell::new(self.get())
 255     }
 256 }
 257
 258 #[stable(feature = "rust1", since = "1.0.0")]
 259 impl<T:Default> Default for Cell<T> {
 260     /// Creates a `Cell<T>`, with the `Default` value for T.
 261     #[inline]
 262     fn default() -> Cell<T> {
 263         Cell::new(Default::default())
 264     }
 265 }
 266
 267 #[stable(feature = "rust1", since = "1.0.0")]
 268 impl<T:PartialEq + Copy> PartialEq for Cell<T> {
 269     #[inline]
 270     fn eq(&self, other: &Cell<T>) -> bool {
 271         self.get() == other.get()
 272     }
 273 }
 274
 275 #[stable(feature = "cell_eq", since = "1.2.0")]
 276 impl<T:Eq + Copy> Eq for Cell<T> {}
 277
 278 #[stable(feature = "cell_ord", since = "1.10.0")]
 279 impl<T:PartialOrd + Copy> PartialOrd for Cell<T> {
 280     #[inline]
 281     fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering> {
 282         self.get().partial_cmp(&other.get())
 283     }
 284
 285     #[inline]
 286     fn lt(&self, other: &Cell<T>) -> bool {
 287         self.get() < other.get()
 288     }
 289
 290     #[inline]
 291     fn le(&self, other: &Cell<T>) -> bool {
 292         self.get() <= other.get()
 293     }
 294
 295     #[inline]
 296     fn gt(&self, other: &Cell<T>) -> bool {
 297         self.get() > other.get()
 298     }
 299
 300     #[inline]
 301     fn ge(&self, other: &Cell<T>) -> bool {
 302         self.get() >= other.get()
 303     }
 304 }
 305
 306 #[stable(feature = "cell_ord", since = "1.10.0")]
 307 impl<T:Ord + Copy> Ord for Cell<T> {
 308     #[inline]
 309     fn cmp(&self, other: &Cell<T>) -> Ordering {
 310         self.get().cmp(&other.get())
 311     }
 312 }
 313
 314 #[stable(feature = "cell_from", since = "1.12.0")]
 315 impl<T> From<T> for Cell<T> {
 316     fn from(t: T) -> Cell<T> {
 317         Cell::new(t)
 318     }
 319 }
 320
 321 impl<T> Cell<T> {
 322     /// Creates a new `Cell` containing the given value.
 323     ///
 324     /// # Examples
 325     ///
 326     /// ```
 327     /// use std::cell::Cell;
 328     ///
 329     /// let c = Cell::new(5);
 330     /// ```
 331     #[stable(feature = "rust1", since = "1.0.0")]
 332     #[inline]
 333     pub const fn new(value: T) -> Cell<T> {
 334         Cell {
 335             value: UnsafeCell::new(value),
 336         }
 337     }
 338
 339     /// Returns a raw pointer to the underlying data in this cell.
 340     ///
 341     /// # Examples
 342     ///
 343     /// ```
 344     /// use std::cell::Cell;
 345     ///
 346     /// let c = Cell::new(5);
 347     ///
 348     /// let ptr = c.as_ptr();
 349     /// ```
 350     #[inline]
 351     #[stable(feature = "cell_as_ptr", since = "1.12.0")]
 352     pub fn as_ptr(&self) -> *mut T {
 353         self.value.get()
 354     }
 355
 356     /// Returns a mutable reference to the underlying data.
 357     ///
 358     /// This call borrows `Cell` mutably (at compile-time) which guarantees
 359     /// that we possess the only reference.
 360     ///
 361     /// # Examples
 362     ///
 363     /// ```
 364     /// use std::cell::Cell;
 365     ///
 366     /// let mut c = Cell::new(5);
 367     /// *c.get_mut() += 1;
 368     ///
 369     /// assert_eq!(c.get(), 6);
 370     /// ```
 371     #[inline]
 372     #[stable(feature = "cell_get_mut", since = "1.11.0")]
 373     pub fn get_mut(&mut self) -> &mut T {
 374         unsafe {
 375             &mut *self.value.get()
 376         }
 377     }
 378
 379     /// Sets the contained value.
 380     ///
 381     /// # Examples
 382     ///
 383     /// ```
 384     /// use std::cell::Cell;
 385     ///
 386     /// let c = Cell::new(5);
 387     ///
 388     /// c.set(10);
 389     /// ```
 390     #[inline]
 391     #[stable(feature = "rust1", since = "1.0.0")]
 392     pub fn set(&self, val: T) {
 393         let old = self.replace(val);
 394         drop(old);
 395     }
 396
 397     /// Swaps the values of two Cells.
 398     /// Difference with `std::mem::swap` is that this function doesn't require `&mut` reference.
 399     ///
 400     /// # Examples
 401     ///
 402     /// ```
 403     /// use std::cell::Cell;
 404     ///
 405     /// let c1 = Cell::new(5i32);
 406     /// let c2 = Cell::new(10i32);
 407     /// c1.swap(&c2);
 408     /// assert_eq!(10, c1.get());
 409     /// assert_eq!(5, c2.get());
 410     /// ```
 411     #[inline]
 412     #[stable(feature = "move_cell", since = "1.17.0")]
 413     pub fn swap(&self, other: &Self) {
 414         if ptr::eq(self, other) {
 415             return;
 416         }
 417         unsafe {
 418             ptr::swap(self.value.get(), other.value.get());
 419         }
 420     }
 421
 422     /// Replaces the contained value, and returns it.
 423     ///
 424     /// # Examples
 425     ///
 426     /// ```
 427     /// use std::cell::Cell;
 428     ///
 429     /// let cell = Cell::new(5);
 430     /// assert_eq!(cell.get(), 5);
 431     /// assert_eq!(cell.replace(10), 5);
 432     /// assert_eq!(cell.get(), 10);
 433     /// ```
 434     #[stable(feature = "move_cell", since = "1.17.0")]
 435     pub fn replace(&self, val: T) -> T {
 436         mem::replace(unsafe { &mut *self.value.get() }, val)
 437     }
 438
 439     /// Unwraps the value.
 440     ///
 441     /// # Examples
 442     ///
 443     /// ```
 444     /// use std::cell::Cell;
 445     ///
 446     /// let c = Cell::new(5);
 447     /// let five = c.into_inner();
 448     ///
 449     /// assert_eq!(five, 5);
 450     /// ```
 451     #[stable(feature = "move_cell", since = "1.17.0")]
 452     pub fn into_inner(self) -> T {
 453         unsafe { self.value.into_inner() }
 454     }
 455 }
 456
 457 impl<T: Default> Cell<T> {
 458     /// Takes the value of the cell, leaving `Default::default()` in its place.
 459     ///
 460     /// # Examples
 461     ///
 462     /// ```
 463     /// use std::cell::Cell;
 464     ///
 465     /// let c = Cell::new(5);
 466     /// let five = c.take();
 467     ///
 468     /// assert_eq!(five, 5);
 469     /// assert_eq!(c.into_inner(), 0);
 470     /// ```
 471     #[stable(feature = "move_cell", since = "1.17.0")]
 472     pub fn take(&self) -> T {
 473         self.replace(Default::default())
 474     }
 475 }
 476
 477 #[unstable(feature = "coerce_unsized", issue = "27732")]
 478 impl<T: CoerceUnsized<U>, U> CoerceUnsized<Cell<U>> for Cell<T> {}
 479
 480 /// A mutable memory location with dynamically checked borrow rules
 481 ///
 482 /// See the [module-level documentation](index.html) for more.
 483 #[stable(feature = "rust1", since = "1.0.0")]
 484 pub struct RefCell<T: ?Sized> {
 485     borrow: Cell<BorrowFlag>,
 486     value: UnsafeCell<T>,
 487 }
 488
 489 /// An error returned by [`RefCell::try_borrow`](struct.RefCell.html#method.try_borrow).
 490 #[stable(feature = "try_borrow", since = "1.13.0")]
 491 pub struct BorrowError {
 492     _private: (),
 493 }
 494
 495 #[stable(feature = "try_borrow", since = "1.13.0")]
 496 impl Debug for BorrowError {
 497     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 498         f.debug_struct("BorrowError").finish()
 499     }
 500 }
 501
 502 #[stable(feature = "try_borrow", since = "1.13.0")]
 503 impl Display for BorrowError {
 504     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 505         Display::fmt("already mutably borrowed", f)
 506     }
 507 }
 508
 509 /// An error returned by [`RefCell::try_borrow_mut`](struct.RefCell.html#method.try_borrow_mut).
 510 #[stable(feature = "try_borrow", since = "1.13.0")]
 511 pub struct BorrowMutError {
 512     _private: (),
 513 }
 514
 515 #[stable(feature = "try_borrow", since = "1.13.0")]
 516 impl Debug for BorrowMutError {
 517     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 518         f.debug_struct("BorrowMutError").finish()
 519     }
 520 }
 521
 522 #[stable(feature = "try_borrow", since = "1.13.0")]
 523 impl Display for BorrowMutError {
 524     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 525         Display::fmt("already borrowed", f)
 526     }
 527 }
 528
 529 // Values [1, MAX-1] represent the number of `Ref` active
 530 // (will not outgrow its range since `usize` is the size of the address space)
 531 type BorrowFlag = usize;
 532 const UNUSED: BorrowFlag = 0;
 533 const WRITING: BorrowFlag = !0;
 534
 535 impl<T> RefCell<T> {
 536     /// Creates a new `RefCell` containing `value`.
 537     ///
 538     /// # Examples
 539     ///
 540     /// ```
 541     /// use std::cell::RefCell;
 542     ///
 543     /// let c = RefCell::new(5);
 544     /// ```
 545     #[stable(feature = "rust1", since = "1.0.0")]
 546     #[inline]
 547     pub const fn new(value: T) -> RefCell<T> {
 548         RefCell {
 549             value: UnsafeCell::new(value),
 550             borrow: Cell::new(UNUSED),
 551         }
 552     }
 553
 554     /// Consumes the `RefCell`, returning the wrapped value.
 555     ///
 556     /// # Examples
 557     ///
 558     /// ```
 559     /// use std::cell::RefCell;
 560     ///
 561     /// let c = RefCell::new(5);
 562     ///
 563     /// let five = c.into_inner();
 564     /// ```
 565     #[stable(feature = "rust1", since = "1.0.0")]
 566     #[inline]
 567     pub fn into_inner(self) -> T {
 568         // Since this function takes `self` (the `RefCell`) by value, the
 569         // compiler statically verifies that it is not currently borrowed.
 570         // Therefore the following assertion is just a `debug_assert!`.
 571         debug_assert!(self.borrow.get() == UNUSED);
 572         unsafe { self.value.into_inner() }
 573     }
 574
 575     /// Replaces the wrapped value with a new one, returning the old value,
 576     /// without deinitializing either one.
 577     ///
 578     /// This function corresponds to [`std::mem::replace`](../mem/fn.replace.html).
 579     ///
 580     /// # Examples
 581     ///
 582     /// ```
 583     /// #![feature(refcell_replace_swap)]
 584     /// use std::cell::RefCell;
 585     /// let c = RefCell::new(5);
 586     /// let u = c.replace(6);
 587     /// assert_eq!(u, 5);
 588     /// assert_eq!(c, RefCell::new(6));
 589     /// ```
 590     ///
 591     /// # Panics
 592     ///
 593     /// This function will panic if the `RefCell` has any outstanding borrows,
 594     /// whether or not they are full mutable borrows.
 595     #[inline]
 596     #[unstable(feature = "refcell_replace_swap", issue="43570")]
 597     pub fn replace(&self, t: T) -> T {
 598         mem::replace(&mut *self.borrow_mut(), t)
 599     }
 600
 601     /// Swaps the wrapped value of `self` with the wrapped value of `other`,
 602     /// without deinitializing either one.
 603     ///
 604     /// This function corresponds to [`std::mem::swap`](../mem/fn.swap.html).
 605     ///
 606     /// # Examples
 607     ///
 608     /// ```
 609     /// #![feature(refcell_replace_swap)]
 610     /// use std::cell::RefCell;
 611     /// let c = RefCell::new(5);
 612     /// let d = RefCell::new(6);
 613     /// c.swap(&d);
 614     /// assert_eq!(c, RefCell::new(6));
 615     /// assert_eq!(d, RefCell::new(5));
 616     /// ```
 617     ///
 618     /// # Panics
 619     ///
 620     /// This function will panic if either `RefCell` has any outstanding borrows,
 621     /// whether or not they are full mutable borrows.
 622     #[inline]
 623     #[unstable(feature = "refcell_replace_swap", issue="43570")]
 624     pub fn swap(&self, other: &Self) {
 625         mem::swap(&mut *self.borrow_mut(), &mut *other.borrow_mut())
 626     }
 627 }
 628
 629 impl<T: ?Sized> RefCell<T> {
 630     /// Immutably borrows the wrapped value.
 631     ///
 632     /// The borrow lasts until the returned `Ref` exits scope. Multiple
 633     /// immutable borrows can be taken out at the same time.
 634     ///
 635     /// # Panics
 636     ///
 637     /// Panics if the value is currently mutably borrowed. For a non-panicking variant, use
 638     /// [`try_borrow`](#method.try_borrow).
 639     ///
 640     /// # Examples
 641     ///
 642     /// ```
 643     /// use std::cell::RefCell;
 644     ///
 645     /// let c = RefCell::new(5);
 646     ///
 647     /// let borrowed_five = c.borrow();
 648     /// let borrowed_five2 = c.borrow();
 649     /// ```
 650     ///
 651     /// An example of panic:
 652     ///
 653     /// ```
 654     /// use std::cell::RefCell;
 655     /// use std::thread;
 656     ///
 657     /// let result = thread::spawn(move || {
 658     ///    let c = RefCell::new(5);
 659     ///    let m = c.borrow_mut();
 660     ///
 661     ///    let b = c.borrow(); // this causes a panic
 662     /// }).join();
 663     ///
 664     /// assert!(result.is_err());
 665     /// ```
 666     #[stable(feature = "rust1", since = "1.0.0")]
 667     #[inline]
 668     pub fn borrow(&self) -> Ref<T> {
 669         self.try_borrow().expect("already mutably borrowed")
 670     }
 671
 672     /// Immutably borrows the wrapped value, returning an error if the value is currently mutably
 673     /// borrowed.
 674     ///
 675     /// The borrow lasts until the returned `Ref` exits scope. Multiple immutable borrows can be
 676     /// taken out at the same time.
 677     ///
 678     /// This is the non-panicking variant of [`borrow`](#method.borrow).
 679     ///
 680     /// # Examples
 681     ///
 682     /// ```
 683     /// use std::cell::RefCell;
 684     ///
 685     /// let c = RefCell::new(5);
 686     ///
 687     /// {
 688     ///     let m = c.borrow_mut();
 689     ///     assert!(c.try_borrow().is_err());
 690     /// }
 691     ///
 692     /// {
 693     ///     let m = c.borrow();
 694     ///     assert!(c.try_borrow().is_ok());
 695     /// }
 696     /// ```
 697     #[stable(feature = "try_borrow", since = "1.13.0")]
 698     #[inline]
 699     pub fn try_borrow(&self) -> Result<Ref<T>, BorrowError> {
 700         match BorrowRef::new(&self.borrow) {
 701             Some(b) => Ok(Ref {
 702                 value: unsafe { &*self.value.get() },
 703                 borrow: b,
 704             }),
 705             None => Err(BorrowError { _private: () }),
 706         }
 707     }
 708
 709     /// Mutably borrows the wrapped value.
 710     ///
 711     /// The borrow lasts until the returned `RefMut` exits scope. The value
 712     /// cannot be borrowed while this borrow is active.
 713     ///
 714     /// # Panics
 715     ///
 716     /// Panics if the value is currently borrowed. For a non-panicking variant, use
 717     /// [`try_borrow_mut`](#method.try_borrow_mut).
 718     ///
 719     /// # Examples
 720     ///
 721     /// ```
 722     /// use std::cell::RefCell;
 723     ///
 724     /// let c = RefCell::new(5);
 725     ///
 726     /// *c.borrow_mut() = 7;
 727     ///
 728     /// assert_eq!(*c.borrow(), 7);
 729     /// ```
 730     ///
 731     /// An example of panic:
 732     ///
 733     /// ```
 734     /// use std::cell::RefCell;
 735     /// use std::thread;
 736     ///
 737     /// let result = thread::spawn(move || {
 738     ///    let c = RefCell::new(5);
 739     ///    let m = c.borrow();
 740     ///
 741     ///    let b = c.borrow_mut(); // this causes a panic
 742     /// }).join();
 743     ///
 744     /// assert!(result.is_err());
 745     /// ```
 746     #[stable(feature = "rust1", since = "1.0.0")]
 747     #[inline]
 748     pub fn borrow_mut(&self) -> RefMut<T> {
 749         self.try_borrow_mut().expect("already borrowed")
 750     }
 751
 752     /// Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
 753     ///
 754     /// The borrow lasts until the returned `RefMut` exits scope. The value cannot be borrowed
 755     /// while this borrow is active.
 756     ///
 757     /// This is the non-panicking variant of [`borrow_mut`](#method.borrow_mut).
 758     ///
 759     /// # Examples
 760     ///
 761     /// ```
 762     /// use std::cell::RefCell;
 763     ///
 764     /// let c = RefCell::new(5);
 765     ///
 766     /// {
 767     ///     let m = c.borrow();
 768     ///     assert!(c.try_borrow_mut().is_err());
 769     /// }
 770     ///
 771     /// assert!(c.try_borrow_mut().is_ok());
 772     /// ```
 773     #[stable(feature = "try_borrow", since = "1.13.0")]
 774     #[inline]
 775     pub fn try_borrow_mut(&self) -> Result<RefMut<T>, BorrowMutError> {
 776         match BorrowRefMut::new(&self.borrow) {
 777             Some(b) => Ok(RefMut {
 778                 value: unsafe { &mut *self.value.get() },
 779                 borrow: b,
 780             }),
 781             None => Err(BorrowMutError { _private: () }),
 782         }
 783     }
 784
 785     /// Returns a raw pointer to the underlying data in this cell.
 786     ///
 787     /// # Examples
 788     ///
 789     /// ```
 790     /// use std::cell::RefCell;
 791     ///
 792     /// let c = RefCell::new(5);
 793     ///
 794     /// let ptr = c.as_ptr();
 795     /// ```
 796     #[inline]
 797     #[stable(feature = "cell_as_ptr", since = "1.12.0")]
 798     pub fn as_ptr(&self) -> *mut T {
 799         self.value.get()
 800     }
 801
 802     /// Returns a mutable reference to the underlying data.
 803     ///
 804     /// This call borrows `RefCell` mutably (at compile-time) so there is no
 805     /// need for dynamic checks.
 806     ///
 807     /// However be cautious: this method expects `self` to be mutable, which is
 808     /// generally not the case when using a `RefCell`. Take a look at the
 809     /// [`borrow_mut`] method instead if `self` isn't mutable.
 810     ///
 811     /// Also, please be aware that this method is only for special circumstances and is usually
 812     /// not what you want. In case of doubt, use [`borrow_mut`] instead.
 813     ///
 814     /// [`borrow_mut`]: #method.borrow_mut
 815     ///
 816     /// # Examples
 817     ///
 818     /// ```
 819     /// use std::cell::RefCell;
 820     ///
 821     /// let mut c = RefCell::new(5);
 822     /// *c.get_mut() += 1;
 823     ///
 824     /// assert_eq!(c, RefCell::new(6));
 825     /// ```
 826     #[inline]
 827     #[stable(feature = "cell_get_mut", since = "1.11.0")]
 828     pub fn get_mut(&mut self) -> &mut T {
 829         unsafe {
 830             &mut *self.value.get()
 831         }
 832     }
 833 }
 834
 835 #[stable(feature = "rust1", since = "1.0.0")]
 836 unsafe impl<T: ?Sized> Send for RefCell<T> where T: Send {}
 837
 838 #[stable(feature = "rust1", since = "1.0.0")]
 839 impl<T: ?Sized> !Sync for RefCell<T> {}
 840
 841 #[stable(feature = "rust1", since = "1.0.0")]
 842 impl<T: Clone> Clone for RefCell<T> {
 843     #[inline]
 844     fn clone(&self) -> RefCell<T> {
 845         RefCell::new(self.borrow().clone())
 846     }
 847 }
 848
 849 #[stable(feature = "rust1", since = "1.0.0")]
 850 impl<T:Default> Default for RefCell<T> {
 851     /// Creates a `RefCell<T>`, with the `Default` value for T.
 852     #[inline]
 853     fn default() -> RefCell<T> {
 854         RefCell::new(Default::default())
 855     }
 856 }
 857
 858 #[stable(feature = "rust1", since = "1.0.0")]
 859 impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> {
 860     #[inline]
 861     fn eq(&self, other: &RefCell<T>) -> bool {
 862         *self.borrow() == *other.borrow()
 863     }
 864 }
 865
 866 #[stable(feature = "cell_eq", since = "1.2.0")]
 867 impl<T: ?Sized + Eq> Eq for RefCell<T> {}
 868
 869 #[stable(feature = "cell_ord", since = "1.10.0")]
 870 impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
 871     #[inline]
 872     fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> {
 873         self.borrow().partial_cmp(&*other.borrow())
 874     }
 875
 876     #[inline]
 877     fn lt(&self, other: &RefCell<T>) -> bool {
 878         *self.borrow() < *other.borrow()
 879     }
 880
 881     #[inline]
 882     fn le(&self, other: &RefCell<T>) -> bool {
 883         *self.borrow() <= *other.borrow()
 884     }
 885
 886     #[inline]
 887     fn gt(&self, other: &RefCell<T>) -> bool {
 888         *self.borrow() > *other.borrow()
 889     }
 890
 891     #[inline]
 892     fn ge(&self, other: &RefCell<T>) -> bool {
 893         *self.borrow() >= *other.borrow()
 894     }
 895 }
 896
 897 #[stable(feature = "cell_ord", since = "1.10.0")]
 898 impl<T: ?Sized + Ord> Ord for RefCell<T> {
 899     #[inline]
 900     fn cmp(&self, other: &RefCell<T>) -> Ordering {
 901         self.borrow().cmp(&*other.borrow())
 902     }
 903 }
 904
 905 #[stable(feature = "cell_from", since = "1.12.0")]
 906 impl<T> From<T> for RefCell<T> {
 907     fn from(t: T) -> RefCell<T> {
 908         RefCell::new(t)
 909     }
 910 }
 911
 912 #[unstable(feature = "coerce_unsized", issue = "27732")]
 913 impl<T: CoerceUnsized<U>, U> CoerceUnsized<RefCell<U>> for RefCell<T> {}
 914
 915 struct BorrowRef<'b> {
 916     borrow: &'b Cell<BorrowFlag>,
 917 }
 918
 919 impl<'b> BorrowRef<'b> {
 920     #[inline]
 921     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRef<'b>> {
 922         match borrow.get() {
 923             WRITING => None,
 924             b => {
 925                 borrow.set(b + 1);
 926                 Some(BorrowRef { borrow: borrow })
 927             },
 928         }
 929     }
 930 }
 931
 932 impl<'b> Drop for BorrowRef<'b> {
 933     #[inline]
 934     fn drop(&mut self) {
 935         let borrow = self.borrow.get();
 936         debug_assert!(borrow != WRITING && borrow != UNUSED);
 937         self.borrow.set(borrow - 1);
 938     }
 939 }
 940
 941 impl<'b> Clone for BorrowRef<'b> {
 942     #[inline]
 943     fn clone(&self) -> BorrowRef<'b> {
 944         // Since this Ref exists, we know the borrow flag
 945         // is not set to WRITING.
 946         let borrow = self.borrow.get();
 947         debug_assert!(borrow != UNUSED);
 948         // Prevent the borrow counter from overflowing.
 949         assert!(borrow != WRITING);
 950         self.borrow.set(borrow + 1);
 951         BorrowRef { borrow: self.borrow }
 952     }
 953 }
 954
 955 /// Wraps a borrowed reference to a value in a `RefCell` box.
 956 /// A wrapper type for an immutably borrowed value from a `RefCell<T>`.
 957 ///
 958 /// See the [module-level documentation](index.html) for more.
 959 #[stable(feature = "rust1", since = "1.0.0")]
 960 pub struct Ref<'b, T: ?Sized + 'b> {
 961     value: &'b T,
 962     borrow: BorrowRef<'b>,
 963 }
 964
 965 #[stable(feature = "rust1", since = "1.0.0")]
 966 impl<'b, T: ?Sized> Deref for Ref<'b, T> {
 967     type Target = T;
 968
 969     #[inline]
 970     fn deref(&self) -> &T {
 971         self.value
 972     }
 973 }
 974
 975 impl<'b, T: ?Sized> Ref<'b, T> {
 976     /// Copies a `Ref`.
 977     ///
 978     /// The `RefCell` is already immutably borrowed, so this cannot fail.
 979     ///
 980     /// This is an associated function that needs to be used as
 981     /// `Ref::clone(...)`.  A `Clone` implementation or a method would interfere
 982     /// with the widespread use of `r.borrow().clone()` to clone the contents of
 983     /// a `RefCell`.
 984     #[stable(feature = "cell_extras", since = "1.15.0")]
 985     #[inline]
 986     pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> {
 987         Ref {
 988             value: orig.value,
 989             borrow: orig.borrow.clone(),
 990         }
 991     }
 992
 993     /// Make a new `Ref` for a component of the borrowed data.
 994     ///
 995     /// The `RefCell` is already immutably borrowed, so this cannot fail.
 996     ///
 997     /// This is an associated function that needs to be used as `Ref::map(...)`.
 998     /// A method would interfere with methods of the same name on the contents
 999     /// of a `RefCell` used through `Deref`.
1000     ///
1001     /// # Example
1002     ///
1003     /// ```
1004     /// use std::cell::{RefCell, Ref};
1005     ///
1006     /// let c = RefCell::new((5, 'b'));
1007     /// let b1: Ref<(u32, char)> = c.borrow();
1008     /// let b2: Ref<u32> = Ref::map(b1, |t| &t.0);
1009     /// assert_eq!(*b2, 5)
1010     /// ```
1011     #[stable(feature = "cell_map", since = "1.8.0")]
1012     #[inline]
1013     pub fn map<U: ?Sized, F>(orig: Ref<'b, T>, f: F) -> Ref<'b, U>
1014         where F: FnOnce(&T) -> &U
1015     {
1016         Ref {
1017             value: f(orig.value),
1018             borrow: orig.borrow,
1019         }
1020     }
1021 }
1022
1023 #[unstable(feature = "coerce_unsized", issue = "27732")]
1024 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Ref<'b, U>> for Ref<'b, T> {}
1025
1026 #[stable(feature = "std_guard_impls", since = "1.20.0")]
1027 impl<'a, T: ?Sized + fmt::Display> fmt::Display for Ref<'a, T> {
1028     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1029         self.value.fmt(f)
1030     }
1031 }
1032
1033 impl<'b, T: ?Sized> RefMut<'b, T> {
1034     /// Make a new `RefMut` for a component of the borrowed data, e.g. an enum
1035     /// variant.
1036     ///
1037     /// The `RefCell` is already mutably borrowed, so this cannot fail.
1038     ///
1039     /// This is an associated function that needs to be used as
1040     /// `RefMut::map(...)`.  A method would interfere with methods of the same
1041     /// name on the contents of a `RefCell` used through `Deref`.
1042     ///
1043     /// # Example
1044     ///
1045     /// ```
1046     /// use std::cell::{RefCell, RefMut};
1047     ///
1048     /// let c = RefCell::new((5, 'b'));
1049     /// {
1050     ///     let b1: RefMut<(u32, char)> = c.borrow_mut();
1051     ///     let mut b2: RefMut<u32> = RefMut::map(b1, |t| &mut t.0);
1052     ///     assert_eq!(*b2, 5);
1053     ///     *b2 = 42;
1054     /// }
1055     /// assert_eq!(*c.borrow(), (42, 'b'));
1056     /// ```
1057     #[stable(feature = "cell_map", since = "1.8.0")]
1058     #[inline]
1059     pub fn map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> RefMut<'b, U>
1060         where F: FnOnce(&mut T) -> &mut U
1061     {
1062         RefMut {
1063             value: f(orig.value),
1064             borrow: orig.borrow,
1065         }
1066     }
1067 }
1068
1069 struct BorrowRefMut<'b> {
1070     borrow: &'b Cell<BorrowFlag>,
1071 }
1072
1073 impl<'b> Drop for BorrowRefMut<'b> {
1074     #[inline]
1075     fn drop(&mut self) {
1076         let borrow = self.borrow.get();
1077         debug_assert!(borrow == WRITING);
1078         self.borrow.set(UNUSED);
1079     }
1080 }
1081
1082 impl<'b> BorrowRefMut<'b> {
1083     #[inline]
1084     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRefMut<'b>> {
1085         match borrow.get() {
1086             UNUSED => {
1087                 borrow.set(WRITING);
1088                 Some(BorrowRefMut { borrow: borrow })
1089             },
1090             _ => None,
1091         }
1092     }
1093 }
1094
1095 /// A wrapper type for a mutably borrowed value from a `RefCell<T>`.
1096 ///
1097 /// See the [module-level documentation](index.html) for more.
1098 #[stable(feature = "rust1", since = "1.0.0")]
1099 pub struct RefMut<'b, T: ?Sized + 'b> {
1100     value: &'b mut T,
1101     borrow: BorrowRefMut<'b>,
1102 }
1103
1104 #[stable(feature = "rust1", since = "1.0.0")]
1105 impl<'b, T: ?Sized> Deref for RefMut<'b, T> {
1106     type Target = T;
1107
1108     #[inline]
1109     fn deref(&self) -> &T {
1110         self.value
1111     }
1112 }
1113
1114 #[stable(feature = "rust1", since = "1.0.0")]
1115 impl<'b, T: ?Sized> DerefMut for RefMut<'b, T> {
1116     #[inline]
1117     fn deref_mut(&mut self) -> &mut T {
1118         self.value
1119     }
1120 }
1121
1122 #[unstable(feature = "coerce_unsized", issue = "27732")]
1123 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<RefMut<'b, U>> for RefMut<'b, T> {}
1124
1125 #[stable(feature = "std_guard_impls", since = "1.20.0")]
1126 impl<'a, T: ?Sized + fmt::Display> fmt::Display for RefMut<'a, T> {
1127     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1128         self.value.fmt(f)
1129     }
1130 }
1131
1132 /// The core primitive for interior mutability in Rust.
1133 ///
1134 /// `UnsafeCell<T>` is a type that wraps some `T` and indicates unsafe interior operations on the
1135 /// wrapped type. Types with an `UnsafeCell<T>` field are considered to have an 'unsafe interior'.
1136 /// The `UnsafeCell<T>` type is the only legal way to obtain aliasable data that is considered
1137 /// mutable. In general, transmuting an `&T` type into an `&mut T` is considered undefined behavior.
1138 ///
1139 /// The compiler makes optimizations based on the knowledge that `&T` is not mutably aliased or
1140 /// mutated, and that `&mut T` is unique. When building abstractions like `Cell`, `RefCell`,
1141 /// `Mutex`, etc, you need to turn these optimizations off. `UnsafeCell` is the only legal way
1142 /// to do this. When `UnsafeCell<T>` is immutably aliased, it is still safe to obtain a mutable
1143 /// reference to its interior and/or to mutate it. However, it is up to the abstraction designer
1144 /// to ensure that no two mutable references obtained this way are active at the same time, and
1145 /// that there are no active mutable references or mutations when an immutable reference is obtained
1146 /// from the cell. This is often done via runtime checks.
1147 ///
1148 /// Note that while mutating or mutably aliasing the contents of an `& UnsafeCell<T>` is
1149 /// okay (provided you enforce the invariants some other way); it is still undefined behavior
1150 /// to have multiple `&mut UnsafeCell<T>` aliases.
1151 ///
1152 ///
1153 /// Types like `Cell<T>` and `RefCell<T>` use this type to wrap their internal data.
1154 ///
1155 /// # Examples
1156 ///
1157 /// ```
1158 /// use std::cell::UnsafeCell;
1159 /// use std::marker::Sync;
1160 ///
1161 /// # #[allow(dead_code)]
1162 /// struct NotThreadSafe<T> {
1163 ///     value: UnsafeCell<T>,
1164 /// }
1165 ///
1166 /// unsafe impl<T> Sync for NotThreadSafe<T> {}
1167 /// ```
1168 #[lang = "unsafe_cell"]
1169 #[stable(feature = "rust1", since = "1.0.0")]
1170 pub struct UnsafeCell<T: ?Sized> {
1171     value: T,
1172 }
1173
1174 #[stable(feature = "rust1", since = "1.0.0")]
1175 impl<T: ?Sized> !Sync for UnsafeCell<T> {}
1176
1177 impl<T> UnsafeCell<T> {
1178     /// Constructs a new instance of `UnsafeCell` which will wrap the specified
1179     /// value.
1180     ///
1181     /// All access to the inner value through methods is `unsafe`.
1182     ///
1183     /// # Examples
1184     ///
1185     /// ```
1186     /// use std::cell::UnsafeCell;
1187     ///
1188     /// let uc = UnsafeCell::new(5);
1189     /// ```
1190     #[stable(feature = "rust1", since = "1.0.0")]
1191     #[inline]
1192     pub const fn new(value: T) -> UnsafeCell<T> {
1193         UnsafeCell { value: value }
1194     }
1195
1196     /// Unwraps the value.
1197     ///
1198     /// # Safety
1199     ///
1200     /// This function is unsafe because this thread or another thread may currently be
1201     /// inspecting the inner value.
1202     ///
1203     /// # Examples
1204     ///
1205     /// ```
1206     /// use std::cell::UnsafeCell;
1207     ///
1208     /// let uc = UnsafeCell::new(5);
1209     ///
1210     /// let five = unsafe { uc.into_inner() };
1211     /// ```
1212     #[inline]
1213     #[stable(feature = "rust1", since = "1.0.0")]
1214     pub unsafe fn into_inner(self) -> T {
1215         self.value
1216     }
1217 }
1218
1219 impl<T: ?Sized> UnsafeCell<T> {
1220     /// Gets a mutable pointer to the wrapped value.
1221     ///
1222     /// This can be cast to a pointer of any kind.
1223     /// Ensure that the access is unique when casting to
1224     /// `&mut T`, and ensure that there are no mutations or mutable
1225     /// aliases going on when casting to `&T`
1226     ///
1227     /// # Examples
1228     ///
1229     /// ```
1230     /// use std::cell::UnsafeCell;
1231     ///
1232     /// let uc = UnsafeCell::new(5);
1233     ///
1234     /// let five = uc.get();
1235     /// ```
1236     #[inline]
1237     #[stable(feature = "rust1", since = "1.0.0")]
1238     pub fn get(&self) -> *mut T {
1239         &self.value as *const T as *mut T
1240     }
1241 }
1242
1243 #[stable(feature = "unsafe_cell_default", since = "1.10.0")]
1244 impl<T: Default> Default for UnsafeCell<T> {
1245     /// Creates an `UnsafeCell`, with the `Default` value for T.
1246     fn default() -> UnsafeCell<T> {
1247         UnsafeCell::new(Default::default())
1248     }
1249 }
1250
1251 #[stable(feature = "cell_from", since = "1.12.0")]
1252 impl<T> From<T> for UnsafeCell<T> {
1253     fn from(t: T) -> UnsafeCell<T> {
1254         UnsafeCell::new(t)
1255     }
1256 }
1257
1258 #[unstable(feature = "coerce_unsized", issue = "27732")]
1259 impl<T: CoerceUnsized<U>, U> CoerceUnsized<UnsafeCell<U>> for UnsafeCell<T> {}
1260
1261 #[allow(unused)]
1262 fn assert_coerce_unsized(a: UnsafeCell<&i32>, b: Cell<&i32>, c: RefCell<&i32>) {
1263     let _: UnsafeCell<&Send> = a;
1264     let _: Cell<&Send> = b;
1265     let _: RefCell<&Send> = c;
1266 }