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>` provides `get` and `set`
  19 //! methods that change the interior value with a single method call. `Cell<T>` though is only
  20 //! compatible with types that implement `Copy`. For other types, one must use the `RefCell<T>`
  21 //! type, acquiring a write lock before mutating.
  22 //!
  23 //! `RefCell<T>` uses Rust's lifetimes to implement 'dynamic borrowing', a process whereby one can
  24 //! claim temporary, exclusive, mutable access to the inner value. Borrows for `RefCell<T>`s are
  25 //! tracked 'at runtime', unlike Rust's native reference types which are entirely tracked
  26 //! statically, at compile time. Because `RefCell<T>` borrows are dynamic it is possible to attempt
  27 //! to borrow a value that is already mutably borrowed; when this happens it results in thread
  28 //! panic.
  29 //!
  30 //! # When to choose interior mutability
  31 //!
  32 //! The more common inherited mutability, where one must have unique access to mutate a value, is
  33 //! one of the key language elements that enables Rust to reason strongly about pointer aliasing,
  34 //! statically preventing crash bugs. Because of that, inherited mutability is preferred, and
  35 //! interior mutability is something of a last resort. Since cell types enable mutation where it
  36 //! would otherwise be disallowed though, there are occasions when interior mutability might be
  37 //! appropriate, or even *must* be used, e.g.
  38 //!
  39 //! * Introducing mutability 'inside' of something immutable
  40 //! * Implementation details of logically-immutable methods.
  41 //! * Mutating implementations of `Clone`.
  42 //!
  43 //! ## Introducing mutability 'inside' of something immutable
  44 //!
  45 //! Many shared smart pointer types, including `Rc<T>` and `Arc<T>`, provide containers that can be
  46 //! cloned and shared between multiple parties. Because the contained values may be
  47 //! multiply-aliased, they can only be borrowed with `&`, not `&mut`. Without cells it would be
  48 //! impossible to mutate data inside of these smart pointers at all.
  49 //!
  50 //! It's very common then to put a `RefCell<T>` inside shared pointer types to reintroduce
  51 //! mutability:
  52 //!
  53 //! ```
  54 //! use std::collections::HashMap;
  55 //! use std::cell::RefCell;
  56 //! use std::rc::Rc;
  57 //!
  58 //! fn main() {
  59 //!     let shared_map: Rc<RefCell<_>> = Rc::new(RefCell::new(HashMap::new()));
  60 //!     shared_map.borrow_mut().insert("africa", 92388);
  61 //!     shared_map.borrow_mut().insert("kyoto", 11837);
  62 //!     shared_map.borrow_mut().insert("piccadilly", 11826);
  63 //!     shared_map.borrow_mut().insert("marbles", 38);
  64 //! }
  65 //! ```
  66 //!
  67 //! Note that this example uses `Rc<T>` and not `Arc<T>`. `RefCell<T>`s are for single-threaded
  68 //! scenarios. Consider using `RwLock<T>` or `Mutex<T>` if you need shared mutability in a
  69 //! multi-threaded situation.
  70 //!
  71 //! ## Implementation details of logically-immutable methods
  72 //!
  73 //! Occasionally it may be desirable not to expose in an API that there is mutation happening
  74 //! "under the hood". This may be because logically the operation is immutable, but e.g. caching
  75 //! forces the implementation to perform mutation; or because you must employ mutation to implement
  76 //! a trait method that was originally defined to take `&self`.
  77 //!
  78 //! ```
  79 //! # #![allow(dead_code)]
  80 //! use std::cell::RefCell;
  81 //!
  82 //! struct Graph {
  83 //!     edges: Vec<(i32, i32)>,
  84 //!     span_tree_cache: RefCell<Option<Vec<(i32, i32)>>>
  85 //! }
  86 //!
  87 //! impl Graph {
  88 //!     fn minimum_spanning_tree(&self) -> Vec<(i32, i32)> {
  89 //!         // Create a new scope to contain the lifetime of the
  90 //!         // dynamic borrow
  91 //!         {
  92 //!             // Take a reference to the inside of cache cell
  93 //!             let mut cache = self.span_tree_cache.borrow_mut();
  94 //!             if cache.is_some() {
  95 //!                 return cache.as_ref().unwrap().clone();
  96 //!             }
  97 //!
  98 //!             let span_tree = self.calc_span_tree();
  99 //!             *cache = Some(span_tree);
 100 //!         }
 101 //!
 102 //!         // Recursive call to return the just-cached value.
 103 //!         // Note that if we had not let the previous borrow
 104 //!         // of the cache fall out of scope then the subsequent
 105 //!         // recursive borrow would cause a dynamic thread panic.
 106 //!         // This is the major hazard of using `RefCell`.
 107 //!         self.minimum_spanning_tree()
 108 //!     }
 109 //! #   fn calc_span_tree(&self) -> Vec<(i32, i32)> { vec![] }
 110 //! }
 111 //! ```
 112 //!
 113 //! ## Mutating implementations of `Clone`
 114 //!
 115 //! This is simply a special - but common - case of the previous: hiding mutability for operations
 116 //! that appear to be immutable. The `clone` method is expected to not change the source value, and
 117 //! is declared to take `&self`, not `&mut self`. Therefore any mutation that happens in the
 118 //! `clone` method must use cell types. For example, `Rc<T>` maintains its reference counts within a
 119 //! `Cell<T>`.
 120 //!
 121 //! ```
 122 //! use std::cell::Cell;
 123 //!
 124 //! struct Rc<T> {
 125 //!     ptr: *mut RcBox<T>
 126 //! }
 127 //!
 128 //! struct RcBox<T> {
 129 //! # #[allow(dead_code)]
 130 //!     value: T,
 131 //!     refcount: Cell<usize>
 132 //! }
 133 //!
 134 //! impl<T> Clone for Rc<T> {
 135 //!     fn clone(&self) -> Rc<T> {
 136 //!         unsafe {
 137 //!             (*self.ptr).refcount.set((*self.ptr).refcount.get() + 1);
 138 //!             Rc { ptr: self.ptr }
 139 //!         }
 140 //!     }
 141 //! }
 142 //! ```
 143 //!
 144
 145 #![stable(feature = "rust1", since = "1.0.0")]
 146
 147 use clone::Clone;
 148 use cmp::{PartialEq, Eq, PartialOrd, Ord, Ordering};
 149 use default::Default;
 150 use marker::{Copy, Send, Sync, Sized, Unsize};
 151 use ops::{Deref, DerefMut, Drop, FnOnce, CoerceUnsized};
 152 use option::Option;
 153 use option::Option::{None, Some};
 154
 155 /// A mutable memory location that admits only `Copy` data.
 156 ///
 157 /// See the [module-level documentation](index.html) for more.
 158 #[stable(feature = "rust1", since = "1.0.0")]
 159 pub struct Cell<T> {
 160     value: UnsafeCell<T>,
 161 }
 162
 163 impl<T:Copy> Cell<T> {
 164     /// Creates a new `Cell` containing the given value.
 165     ///
 166     /// # Examples
 167     ///
 168     /// ```
 169     /// use std::cell::Cell;
 170     ///
 171     /// let c = Cell::new(5);
 172     /// ```
 173     #[stable(feature = "rust1", since = "1.0.0")]
 174     #[inline]
 175     pub const fn new(value: T) -> Cell<T> {
 176         Cell {
 177             value: UnsafeCell::new(value),
 178         }
 179     }
 180
 181     /// Returns a copy of the contained value.
 182     ///
 183     /// # Examples
 184     ///
 185     /// ```
 186     /// use std::cell::Cell;
 187     ///
 188     /// let c = Cell::new(5);
 189     ///
 190     /// let five = c.get();
 191     /// ```
 192     #[inline]
 193     #[stable(feature = "rust1", since = "1.0.0")]
 194     pub fn get(&self) -> T {
 195         unsafe{ *self.value.get() }
 196     }
 197
 198     /// Sets the contained value.
 199     ///
 200     /// # Examples
 201     ///
 202     /// ```
 203     /// use std::cell::Cell;
 204     ///
 205     /// let c = Cell::new(5);
 206     ///
 207     /// c.set(10);
 208     /// ```
 209     #[inline]
 210     #[stable(feature = "rust1", since = "1.0.0")]
 211     pub fn set(&self, value: T) {
 212         unsafe {
 213             *self.value.get() = value;
 214         }
 215     }
 216
 217     /// Returns a reference to the underlying `UnsafeCell`.
 218     ///
 219     /// # Examples
 220     ///
 221     /// ```
 222     /// #![feature(as_unsafe_cell)]
 223     ///
 224     /// use std::cell::Cell;
 225     ///
 226     /// let c = Cell::new(5);
 227     ///
 228     /// let uc = c.as_unsafe_cell();
 229     /// ```
 230     #[inline]
 231     #[unstable(feature = "as_unsafe_cell", issue = "27708")]
 232     pub fn as_unsafe_cell(&self) -> &UnsafeCell<T> {
 233         &self.value
 234     }
 235
 236     /// Returns a mutable reference to the underlying data.
 237     ///
 238     /// This call borrows `Cell` mutably (at compile-time) which guarantees
 239     /// that we possess the only reference.
 240     #[inline]
 241     #[unstable(feature = "cell_get_mut", issue = "33444")]
 242     pub fn get_mut(&mut self) -> &mut T {
 243         unsafe {
 244             &mut *self.value.get()
 245         }
 246     }
 247 }
 248
 249 #[stable(feature = "rust1", since = "1.0.0")]
 250 unsafe impl<T> Send for Cell<T> where T: Send {}
 251
 252 #[stable(feature = "rust1", since = "1.0.0")]
 253 impl<T> !Sync for Cell<T> {}
 254
 255 #[stable(feature = "rust1", since = "1.0.0")]
 256 impl<T:Copy> Clone for Cell<T> {
 257     #[inline]
 258     fn clone(&self) -> Cell<T> {
 259         Cell::new(self.get())
 260     }
 261 }
 262
 263 #[stable(feature = "rust1", since = "1.0.0")]
 264 impl<T:Default + Copy> Default for Cell<T> {
 265     #[inline]
 266     fn default() -> Cell<T> {
 267         Cell::new(Default::default())
 268     }
 269 }
 270
 271 #[stable(feature = "rust1", since = "1.0.0")]
 272 impl<T:PartialEq + Copy> PartialEq for Cell<T> {
 273     #[inline]
 274     fn eq(&self, other: &Cell<T>) -> bool {
 275         self.get() == other.get()
 276     }
 277 }
 278
 279 #[stable(feature = "cell_eq", since = "1.2.0")]
 280 impl<T:Eq + Copy> Eq for Cell<T> {}
 281
 282 #[stable(feature = "cell_ord", since = "1.10.0")]
 283 impl<T:PartialOrd + Copy> PartialOrd for Cell<T> {
 284     #[inline]
 285     fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering> {
 286         self.get().partial_cmp(&other.get())
 287     }
 288
 289     #[inline]
 290     fn lt(&self, other: &Cell<T>) -> bool {
 291         self.get() < other.get()
 292     }
 293
 294     #[inline]
 295     fn le(&self, other: &Cell<T>) -> bool {
 296         self.get() <= other.get()
 297     }
 298
 299     #[inline]
 300     fn gt(&self, other: &Cell<T>) -> bool {
 301         self.get() > other.get()
 302     }
 303
 304     #[inline]
 305     fn ge(&self, other: &Cell<T>) -> bool {
 306         self.get() >= other.get()
 307     }
 308 }
 309
 310 #[stable(feature = "cell_ord", since = "1.10.0")]
 311 impl<T:Ord + Copy> Ord for Cell<T> {
 312     #[inline]
 313     fn cmp(&self, other: &Cell<T>) -> Ordering {
 314         self.get().cmp(&other.get())
 315     }
 316 }
 317
 318 /// A mutable memory location with dynamically checked borrow rules
 319 ///
 320 /// See the [module-level documentation](index.html) for more.
 321 #[stable(feature = "rust1", since = "1.0.0")]
 322 pub struct RefCell<T: ?Sized> {
 323     borrow: Cell<BorrowFlag>,
 324     value: UnsafeCell<T>,
 325 }
 326
 327 /// An enumeration of values returned from the `state` method on a `RefCell<T>`.
 328 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 329 #[unstable(feature = "borrow_state", issue = "27733")]
 330 pub enum BorrowState {
 331     /// The cell is currently being read, there is at least one active `borrow`.
 332     Reading,
 333     /// The cell is currently being written to, there is an active `borrow_mut`.
 334     Writing,
 335     /// There are no outstanding borrows on this cell.
 336     Unused,
 337 }
 338
 339 // Values [1, MAX-1] represent the number of `Ref` active
 340 // (will not outgrow its range since `usize` is the size of the address space)
 341 type BorrowFlag = usize;
 342 const UNUSED: BorrowFlag = 0;
 343 const WRITING: BorrowFlag = !0;
 344
 345 impl<T> RefCell<T> {
 346     /// Creates a new `RefCell` containing `value`.
 347     ///
 348     /// # Examples
 349     ///
 350     /// ```
 351     /// use std::cell::RefCell;
 352     ///
 353     /// let c = RefCell::new(5);
 354     /// ```
 355     #[stable(feature = "rust1", since = "1.0.0")]
 356     #[inline]
 357     pub const fn new(value: T) -> RefCell<T> {
 358         RefCell {
 359             value: UnsafeCell::new(value),
 360             borrow: Cell::new(UNUSED),
 361         }
 362     }
 363
 364     /// Consumes the `RefCell`, returning the wrapped value.
 365     ///
 366     /// # Examples
 367     ///
 368     /// ```
 369     /// use std::cell::RefCell;
 370     ///
 371     /// let c = RefCell::new(5);
 372     ///
 373     /// let five = c.into_inner();
 374     /// ```
 375     #[stable(feature = "rust1", since = "1.0.0")]
 376     #[inline]
 377     pub fn into_inner(self) -> T {
 378         // Since this function takes `self` (the `RefCell`) by value, the
 379         // compiler statically verifies that it is not currently borrowed.
 380         // Therefore the following assertion is just a `debug_assert!`.
 381         debug_assert!(self.borrow.get() == UNUSED);
 382         unsafe { self.value.into_inner() }
 383     }
 384 }
 385
 386 impl<T: ?Sized> RefCell<T> {
 387     /// Query the current state of this `RefCell`
 388     ///
 389     /// The returned value can be dispatched on to determine if a call to
 390     /// `borrow` or `borrow_mut` would succeed.
 391     #[unstable(feature = "borrow_state", issue = "27733")]
 392     #[inline]
 393     pub fn borrow_state(&self) -> BorrowState {
 394         match self.borrow.get() {
 395             WRITING => BorrowState::Writing,
 396             UNUSED => BorrowState::Unused,
 397             _ => BorrowState::Reading,
 398         }
 399     }
 400
 401     /// Immutably borrows the wrapped value.
 402     ///
 403     /// The borrow lasts until the returned `Ref` exits scope. Multiple
 404     /// immutable borrows can be taken out at the same time.
 405     ///
 406     /// # Panics
 407     ///
 408     /// Panics if the value is currently mutably borrowed.
 409     ///
 410     /// # Examples
 411     ///
 412     /// ```
 413     /// use std::cell::RefCell;
 414     ///
 415     /// let c = RefCell::new(5);
 416     ///
 417     /// let borrowed_five = c.borrow();
 418     /// let borrowed_five2 = c.borrow();
 419     /// ```
 420     ///
 421     /// An example of panic:
 422     ///
 423     /// ```
 424     /// use std::cell::RefCell;
 425     /// use std::thread;
 426     ///
 427     /// let result = thread::spawn(move || {
 428     ///    let c = RefCell::new(5);
 429     ///    let m = c.borrow_mut();
 430     ///
 431     ///    let b = c.borrow(); // this causes a panic
 432     /// }).join();
 433     ///
 434     /// assert!(result.is_err());
 435     /// ```
 436     #[stable(feature = "rust1", since = "1.0.0")]
 437     #[inline]
 438     pub fn borrow(&self) -> Ref<T> {
 439         match BorrowRef::new(&self.borrow) {
 440             Some(b) => Ref {
 441                 value: unsafe { &*self.value.get() },
 442                 borrow: b,
 443             },
 444             None => panic!("RefCell<T> already mutably borrowed"),
 445         }
 446     }
 447
 448     /// Mutably borrows the wrapped value.
 449     ///
 450     /// The borrow lasts until the returned `RefMut` exits scope. The value
 451     /// cannot be borrowed while this borrow is active.
 452     ///
 453     /// # Panics
 454     ///
 455     /// Panics if the value is currently borrowed.
 456     ///
 457     /// # Examples
 458     ///
 459     /// ```
 460     /// use std::cell::RefCell;
 461     ///
 462     /// let c = RefCell::new(5);
 463     ///
 464     /// *c.borrow_mut() = 7;
 465     ///
 466     /// assert_eq!(*c.borrow(), 7);
 467     /// ```
 468     ///
 469     /// An example of panic:
 470     ///
 471     /// ```
 472     /// use std::cell::RefCell;
 473     /// use std::thread;
 474     ///
 475     /// let result = thread::spawn(move || {
 476     ///    let c = RefCell::new(5);
 477     ///    let m = c.borrow();
 478     ///
 479     ///    let b = c.borrow_mut(); // this causes a panic
 480     /// }).join();
 481     ///
 482     /// assert!(result.is_err());
 483     /// ```
 484     #[stable(feature = "rust1", since = "1.0.0")]
 485     #[inline]
 486     pub fn borrow_mut(&self) -> RefMut<T> {
 487         match BorrowRefMut::new(&self.borrow) {
 488             Some(b) => RefMut {
 489                 value: unsafe { &mut *self.value.get() },
 490                 borrow: b,
 491             },
 492             None => panic!("RefCell<T> already borrowed"),
 493         }
 494     }
 495
 496     /// Returns a reference to the underlying `UnsafeCell`.
 497     ///
 498     /// This can be used to circumvent `RefCell`'s safety checks.
 499     ///
 500     /// This function is `unsafe` because `UnsafeCell`'s field is public.
 501     #[inline]
 502     #[unstable(feature = "as_unsafe_cell", issue = "27708")]
 503     pub unsafe fn as_unsafe_cell(&self) -> &UnsafeCell<T> {
 504         &self.value
 505     }
 506
 507     /// Returns a mutable reference to the underlying data.
 508     ///
 509     /// This call borrows `RefCell` mutably (at compile-time) so there is no
 510     /// need for dynamic checks.
 511     #[inline]
 512     #[unstable(feature = "cell_get_mut", issue="33444")]
 513     pub fn get_mut(&mut self) -> &mut T {
 514         unsafe {
 515             &mut *self.value.get()
 516         }
 517     }
 518 }
 519
 520 #[stable(feature = "rust1", since = "1.0.0")]
 521 unsafe impl<T: ?Sized> Send for RefCell<T> where T: Send {}
 522
 523 #[stable(feature = "rust1", since = "1.0.0")]
 524 impl<T: ?Sized> !Sync for RefCell<T> {}
 525
 526 #[stable(feature = "rust1", since = "1.0.0")]
 527 impl<T: Clone> Clone for RefCell<T> {
 528     #[inline]
 529     fn clone(&self) -> RefCell<T> {
 530         RefCell::new(self.borrow().clone())
 531     }
 532 }
 533
 534 #[stable(feature = "rust1", since = "1.0.0")]
 535 impl<T:Default> Default for RefCell<T> {
 536     #[inline]
 537     fn default() -> RefCell<T> {
 538         RefCell::new(Default::default())
 539     }
 540 }
 541
 542 #[stable(feature = "rust1", since = "1.0.0")]
 543 impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> {
 544     #[inline]
 545     fn eq(&self, other: &RefCell<T>) -> bool {
 546         *self.borrow() == *other.borrow()
 547     }
 548 }
 549
 550 #[stable(feature = "cell_eq", since = "1.2.0")]
 551 impl<T: ?Sized + Eq> Eq for RefCell<T> {}
 552
 553 #[stable(feature = "cell_ord", since = "1.10.0")]
 554 impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
 555     #[inline]
 556     fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> {
 557         self.borrow().partial_cmp(&*other.borrow())
 558     }
 559
 560     #[inline]
 561     fn lt(&self, other: &RefCell<T>) -> bool {
 562         *self.borrow() < *other.borrow()
 563     }
 564
 565     #[inline]
 566     fn le(&self, other: &RefCell<T>) -> bool {
 567         *self.borrow() <= *other.borrow()
 568     }
 569
 570     #[inline]
 571     fn gt(&self, other: &RefCell<T>) -> bool {
 572         *self.borrow() > *other.borrow()
 573     }
 574
 575     #[inline]
 576     fn ge(&self, other: &RefCell<T>) -> bool {
 577         *self.borrow() >= *other.borrow()
 578     }
 579 }
 580
 581 #[stable(feature = "cell_ord", since = "1.10.0")]
 582 impl<T: ?Sized + Ord> Ord for RefCell<T> {
 583     #[inline]
 584     fn cmp(&self, other: &RefCell<T>) -> Ordering {
 585         self.borrow().cmp(&*other.borrow())
 586     }
 587 }
 588
 589 struct BorrowRef<'b> {
 590     borrow: &'b Cell<BorrowFlag>,
 591 }
 592
 593 impl<'b> BorrowRef<'b> {
 594     #[inline]
 595     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRef<'b>> {
 596         match borrow.get() {
 597             WRITING => None,
 598             b => {
 599                 borrow.set(b + 1);
 600                 Some(BorrowRef { borrow: borrow })
 601             },
 602         }
 603     }
 604 }
 605
 606 impl<'b> Drop for BorrowRef<'b> {
 607     #[inline]
 608     fn drop(&mut self) {
 609         let borrow = self.borrow.get();
 610         debug_assert!(borrow != WRITING && borrow != UNUSED);
 611         self.borrow.set(borrow - 1);
 612     }
 613 }
 614
 615 impl<'b> Clone for BorrowRef<'b> {
 616     #[inline]
 617     fn clone(&self) -> BorrowRef<'b> {
 618         // Since this Ref exists, we know the borrow flag
 619         // is not set to WRITING.
 620         let borrow = self.borrow.get();
 621         debug_assert!(borrow != WRITING && borrow != UNUSED);
 622         self.borrow.set(borrow + 1);
 623         BorrowRef { borrow: self.borrow }
 624     }
 625 }
 626
 627 /// Wraps a borrowed reference to a value in a `RefCell` box.
 628 /// A wrapper type for an immutably borrowed value from a `RefCell<T>`.
 629 ///
 630 /// See the [module-level documentation](index.html) for more.
 631 #[stable(feature = "rust1", since = "1.0.0")]
 632 pub struct Ref<'b, T: ?Sized + 'b> {
 633     value: &'b T,
 634     borrow: BorrowRef<'b>,
 635 }
 636
 637 #[stable(feature = "rust1", since = "1.0.0")]
 638 impl<'b, T: ?Sized> Deref for Ref<'b, T> {
 639     type Target = T;
 640
 641     #[inline]
 642     fn deref(&self) -> &T {
 643         self.value
 644     }
 645 }
 646
 647 impl<'b, T: ?Sized> Ref<'b, T> {
 648     /// Copies a `Ref`.
 649     ///
 650     /// The `RefCell` is already immutably borrowed, so this cannot fail.
 651     ///
 652     /// This is an associated function that needs to be used as
 653     /// `Ref::clone(...)`.  A `Clone` implementation or a method would interfere
 654     /// with the widespread use of `r.borrow().clone()` to clone the contents of
 655     /// a `RefCell`.
 656     #[unstable(feature = "cell_extras",
 657                reason = "likely to be moved to a method, pending language changes",
 658                issue = "27746")]
 659     #[inline]
 660     pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> {
 661         Ref {
 662             value: orig.value,
 663             borrow: orig.borrow.clone(),
 664         }
 665     }
 666
 667     /// Make a new `Ref` for a component of the borrowed data.
 668     ///
 669     /// The `RefCell` is already immutably borrowed, so this cannot fail.
 670     ///
 671     /// This is an associated function that needs to be used as `Ref::map(...)`.
 672     /// A method would interfere with methods of the same name on the contents
 673     /// of a `RefCell` used through `Deref`.
 674     ///
 675     /// # Example
 676     ///
 677     /// ```
 678     /// use std::cell::{RefCell, Ref};
 679     ///
 680     /// let c = RefCell::new((5, 'b'));
 681     /// let b1: Ref<(u32, char)> = c.borrow();
 682     /// let b2: Ref<u32> = Ref::map(b1, |t| &t.0);
 683     /// assert_eq!(*b2, 5)
 684     /// ```
 685     #[stable(feature = "cell_map", since = "1.8.0")]
 686     #[inline]
 687     pub fn map<U: ?Sized, F>(orig: Ref<'b, T>, f: F) -> Ref<'b, U>
 688         where F: FnOnce(&T) -> &U
 689     {
 690         Ref {
 691             value: f(orig.value),
 692             borrow: orig.borrow,
 693         }
 694     }
 695
 696     /// Make a new `Ref` for an optional component of the borrowed data, e.g. an
 697     /// enum variant.
 698     ///
 699     /// The `RefCell` is already immutably borrowed, so this cannot fail.
 700     ///
 701     /// This is an associated function that needs to be used as
 702     /// `Ref::filter_map(...)`.  A method would interfere with methods of the
 703     /// same name on the contents of a `RefCell` used through `Deref`.
 704     ///
 705     /// # Example
 706     ///
 707     /// ```
 708     /// # #![feature(cell_extras)]
 709     /// use std::cell::{RefCell, Ref};
 710     ///
 711     /// let c = RefCell::new(Ok(5));
 712     /// let b1: Ref<Result<u32, ()>> = c.borrow();
 713     /// let b2: Ref<u32> = Ref::filter_map(b1, |o| o.as_ref().ok()).unwrap();
 714     /// assert_eq!(*b2, 5)
 715     /// ```
 716     #[unstable(feature = "cell_extras", reason = "recently added",
 717                issue = "27746")]
 718     #[rustc_deprecated(since = "1.8.0", reason = "can be built on `Ref::map`: \
 719         https://crates.io/crates/ref_filter_map")]
 720     #[inline]
 721     pub fn filter_map<U: ?Sized, F>(orig: Ref<'b, T>, f: F) -> Option<Ref<'b, U>>
 722         where F: FnOnce(&T) -> Option<&U>
 723     {
 724         f(orig.value).map(move |new| Ref {
 725             value: new,
 726             borrow: orig.borrow,
 727         })
 728     }
 729 }
 730
 731 #[unstable(feature = "coerce_unsized", issue = "27732")]
 732 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Ref<'b, U>> for Ref<'b, T> {}
 733
 734 impl<'b, T: ?Sized> RefMut<'b, T> {
 735     /// Make a new `RefMut` for a component of the borrowed data, e.g. an enum
 736     /// variant.
 737     ///
 738     /// The `RefCell` is already mutably borrowed, so this cannot fail.
 739     ///
 740     /// This is an associated function that needs to be used as
 741     /// `RefMut::map(...)`.  A method would interfere with methods of the same
 742     /// name on the contents of a `RefCell` used through `Deref`.
 743     ///
 744     /// # Example
 745     ///
 746     /// ```
 747     /// use std::cell::{RefCell, RefMut};
 748     ///
 749     /// let c = RefCell::new((5, 'b'));
 750     /// {
 751     ///     let b1: RefMut<(u32, char)> = c.borrow_mut();
 752     ///     let mut b2: RefMut<u32> = RefMut::map(b1, |t| &mut t.0);
 753     ///     assert_eq!(*b2, 5);
 754     ///     *b2 = 42;
 755     /// }
 756     /// assert_eq!(*c.borrow(), (42, 'b'));
 757     /// ```
 758     #[stable(feature = "cell_map", since = "1.8.0")]
 759     #[inline]
 760     pub fn map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> RefMut<'b, U>
 761         where F: FnOnce(&mut T) -> &mut U
 762     {
 763         RefMut {
 764             value: f(orig.value),
 765             borrow: orig.borrow,
 766         }
 767     }
 768
 769     /// Make a new `RefMut` for an optional component of the borrowed data, e.g.
 770     /// an enum variant.
 771     ///
 772     /// The `RefCell` is already mutably borrowed, so this cannot fail.
 773     ///
 774     /// This is an associated function that needs to be used as
 775     /// `RefMut::filter_map(...)`.  A method would interfere with methods of the
 776     /// same name on the contents of a `RefCell` used through `Deref`.
 777     ///
 778     /// # Example
 779     ///
 780     /// ```
 781     /// # #![feature(cell_extras)]
 782     /// use std::cell::{RefCell, RefMut};
 783     ///
 784     /// let c = RefCell::new(Ok(5));
 785     /// {
 786     ///     let b1: RefMut<Result<u32, ()>> = c.borrow_mut();
 787     ///     let mut b2: RefMut<u32> = RefMut::filter_map(b1, |o| {
 788     ///         o.as_mut().ok()
 789     ///     }).unwrap();
 790     ///     assert_eq!(*b2, 5);
 791     ///     *b2 = 42;
 792     /// }
 793     /// assert_eq!(*c.borrow(), Ok(42));
 794     /// ```
 795     #[unstable(feature = "cell_extras", reason = "recently added",
 796                issue = "27746")]
 797     #[rustc_deprecated(since = "1.8.0", reason = "can be built on `RefMut::map`: \
 798         https://crates.io/crates/ref_filter_map")]
 799     #[inline]
 800     pub fn filter_map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> Option<RefMut<'b, U>>
 801         where F: FnOnce(&mut T) -> Option<&mut U>
 802     {
 803         let RefMut { value, borrow } = orig;
 804         f(value).map(move |new| RefMut {
 805             value: new,
 806             borrow: borrow,
 807         })
 808     }
 809 }
 810
 811 struct BorrowRefMut<'b> {
 812     borrow: &'b Cell<BorrowFlag>,
 813 }
 814
 815 impl<'b> Drop for BorrowRefMut<'b> {
 816     #[inline]
 817     fn drop(&mut self) {
 818         let borrow = self.borrow.get();
 819         debug_assert!(borrow == WRITING);
 820         self.borrow.set(UNUSED);
 821     }
 822 }
 823
 824 impl<'b> BorrowRefMut<'b> {
 825     #[inline]
 826     fn new(borrow: &'b Cell<BorrowFlag>) -> Option<BorrowRefMut<'b>> {
 827         match borrow.get() {
 828             UNUSED => {
 829                 borrow.set(WRITING);
 830                 Some(BorrowRefMut { borrow: borrow })
 831             },
 832             _ => None,
 833         }
 834     }
 835 }
 836
 837 /// A wrapper type for a mutably borrowed value from a `RefCell<T>`.
 838 ///
 839 /// See the [module-level documentation](index.html) for more.
 840 #[stable(feature = "rust1", since = "1.0.0")]
 841 pub struct RefMut<'b, T: ?Sized + 'b> {
 842     value: &'b mut T,
 843     borrow: BorrowRefMut<'b>,
 844 }
 845
 846 #[stable(feature = "rust1", since = "1.0.0")]
 847 impl<'b, T: ?Sized> Deref for RefMut<'b, T> {
 848     type Target = T;
 849
 850     #[inline]
 851     fn deref(&self) -> &T {
 852         self.value
 853     }
 854 }
 855
 856 #[stable(feature = "rust1", since = "1.0.0")]
 857 impl<'b, T: ?Sized> DerefMut for RefMut<'b, T> {
 858     #[inline]
 859     fn deref_mut(&mut self) -> &mut T {
 860         self.value
 861     }
 862 }
 863
 864 #[unstable(feature = "coerce_unsized", issue = "27732")]
 865 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<RefMut<'b, U>> for RefMut<'b, T> {}
 866
 867 /// The core primitive for interior mutability in Rust.
 868 ///
 869 /// `UnsafeCell<T>` is a type that wraps some `T` and indicates unsafe interior operations on the
 870 /// wrapped type. Types with an `UnsafeCell<T>` field are considered to have an 'unsafe interior'.
 871 /// The `UnsafeCell<T>` type is the only legal way to obtain aliasable data that is considered
 872 /// mutable. In general, transmuting an `&T` type into an `&mut T` is considered undefined behavior.
 873 ///
 874 /// Types like `Cell<T>` and `RefCell<T>` use this type to wrap their internal data.
 875 ///
 876 /// # Examples
 877 ///
 878 /// ```
 879 /// use std::cell::UnsafeCell;
 880 /// use std::marker::Sync;
 881 ///
 882 /// # #[allow(dead_code)]
 883 /// struct NotThreadSafe<T> {
 884 ///     value: UnsafeCell<T>,
 885 /// }
 886 ///
 887 /// unsafe impl<T> Sync for NotThreadSafe<T> {}
 888 /// ```
 889 #[lang = "unsafe_cell"]
 890 #[stable(feature = "rust1", since = "1.0.0")]
 891 pub struct UnsafeCell<T: ?Sized> {
 892     value: T,
 893 }
 894
 895 #[stable(feature = "rust1", since = "1.0.0")]
 896 impl<T: ?Sized> !Sync for UnsafeCell<T> {}
 897
 898 impl<T> UnsafeCell<T> {
 899     /// Constructs a new instance of `UnsafeCell` which will wrap the specified
 900     /// value.
 901     ///
 902     /// All access to the inner value through methods is `unsafe`.
 903     ///
 904     /// # Examples
 905     ///
 906     /// ```
 907     /// use std::cell::UnsafeCell;
 908     ///
 909     /// let uc = UnsafeCell::new(5);
 910     /// ```
 911     #[stable(feature = "rust1", since = "1.0.0")]
 912     #[inline]
 913     pub const fn new(value: T) -> UnsafeCell<T> {
 914         UnsafeCell { value: value }
 915     }
 916
 917     /// Unwraps the value.
 918     ///
 919     /// # Safety
 920     ///
 921     /// This function is unsafe because this thread or another thread may currently be
 922     /// inspecting the inner value.
 923     ///
 924     /// # Examples
 925     ///
 926     /// ```
 927     /// use std::cell::UnsafeCell;
 928     ///
 929     /// let uc = UnsafeCell::new(5);
 930     ///
 931     /// let five = unsafe { uc.into_inner() };
 932     /// ```
 933     #[inline]
 934     #[stable(feature = "rust1", since = "1.0.0")]
 935     pub unsafe fn into_inner(self) -> T {
 936         self.value
 937     }
 938 }
 939
 940 impl<T: ?Sized> UnsafeCell<T> {
 941     /// Gets a mutable pointer to the wrapped value.
 942     ///
 943     /// # Examples
 944     ///
 945     /// ```
 946     /// use std::cell::UnsafeCell;
 947     ///
 948     /// let uc = UnsafeCell::new(5);
 949     ///
 950     /// let five = uc.get();
 951     /// ```
 952     #[inline]
 953     #[stable(feature = "rust1", since = "1.0.0")]
 954     pub fn get(&self) -> *mut T {
 955         &self.value as *const T as *mut T
 956     }
 957 }
 958
 959 #[stable(feature = "unsafe_cell_default", since = "1.9.0")]
 960 impl<T: Default> Default for UnsafeCell<T> {
 961     fn default() -> UnsafeCell<T> {
 962         UnsafeCell::new(Default::default())
 963     }
 964 }