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.
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.
11 //! Shareable mutable containers.
13 //! Rust memory safety is based on this rule: Given an object `T`, it is only possible to
14 //! have one of the following:
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**).
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
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.
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'.
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:
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
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
56 //! # When to choose interior mutability
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.
65 //! * Introducing mutability 'inside' of something immutable
66 //! * Implementation details of logically-immutable methods.
67 //! * Mutating implementations of `Clone`.
69 //! ## Introducing mutability 'inside' of something immutable
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.
76 //! It's very common then to put a `RefCell<T>` inside shared pointer types to reintroduce
80 //! use std::collections::HashMap;
81 //! use std::cell::RefCell;
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);
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.
97 //! ## Implementation details of logically-immutable methods
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`.
105 //! # #![allow(dead_code)]
106 //! use std::cell::RefCell;
109 //! edges: Vec<(i32, i32)>,
110 //! span_tree_cache: RefCell<Option<Vec<(i32, i32)>>>
114 //! fn minimum_spanning_tree(&self) -> Vec<(i32, i32)> {
115 //! // Create a new scope to contain the lifetime of the
116 //! // dynamic borrow
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();
124 //! let span_tree = self.calc_span_tree();
125 //! *cache = Some(span_tree);
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()
135 //! # fn calc_span_tree(&self) -> Vec<(i32, i32)> { vec![] }
139 //! ## Mutating implementations of `Clone`
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
148 //! #![feature(core_intrinsics)]
149 //! use std::cell::Cell;
150 //! use std::ptr::NonNull;
151 //! use std::intrinsics::abort;
153 //! struct Rc<T: ?Sized> {
154 //! ptr: NonNull<RcBox<T>>
157 //! struct RcBox<T: ?Sized> {
158 //! strong: Cell<usize>,
159 //! refcount: Cell<usize>,
163 //! impl<T: ?Sized> Clone for Rc<T> {
164 //! fn clone(&self) -> Rc<T> {
165 //! self.inc_strong();
166 //! Rc { ptr: self.ptr }
170 //! trait RcBoxPtr<T: ?Sized> {
172 //! fn inner(&self) -> &RcBox<T>;
174 //! fn strong(&self) -> usize {
175 //! self.inner().strong.get()
178 //! fn inc_strong(&self) {
181 //! .set(self.strong()
183 //! .unwrap_or_else(|| unsafe { abort() }));
187 //! impl<T: ?Sized> RcBoxPtr<T> for Rc<T> {
188 //! fn inner(&self) -> &RcBox<T> {
190 //! self.ptr.as_ref()
197 #![stable(feature = "rust1", since = "1.0.0")]
200 use fmt::{self, Debug, Display};
203 use ops::{Deref, DerefMut, CoerceUnsized};
206 /// A mutable memory location.
210 /// Here you can see how using `Cell<T>` allows to use mutable field inside
211 /// immutable struct (which is also called 'interior mutability').
214 /// use std::cell::Cell;
216 /// struct SomeStruct {
217 /// regular_field: u8,
218 /// special_field: Cell<u8>,
221 /// let my_struct = SomeStruct {
222 /// regular_field: 0,
223 /// special_field: Cell::new(1),
226 /// let new_value = 100;
228 /// // ERROR, because my_struct is immutable
229 /// // my_struct.regular_field = new_value;
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);
236 /// See the [module-level documentation](index.html) for more.
237 #[stable(feature = "rust1", since = "1.0.0")]
240 value: UnsafeCell<T>,
243 impl<T:Copy> Cell<T> {
244 /// Returns a copy of the contained value.
249 /// use std::cell::Cell;
251 /// let c = Cell::new(5);
253 /// let five = c.get();
256 #[stable(feature = "rust1", since = "1.0.0")]
257 pub fn get(&self) -> T {
258 unsafe{ *self.value.get() }
261 /// Updates the contained value using a function and returns the new value.
266 /// #![feature(cell_update)]
268 /// use std::cell::Cell;
270 /// let c = Cell::new(5);
271 /// let new = c.update(|x| x + 1);
273 /// assert_eq!(new, 6);
274 /// assert_eq!(c.get(), 6);
277 #[unstable(feature = "cell_update", issue = "50186")]
278 pub fn update<F>(&self, f: F) -> T
282 let old = self.get();
289 #[stable(feature = "rust1", since = "1.0.0")]
290 unsafe impl<T> Send for Cell<T> where T: Send {}
292 #[stable(feature = "rust1", since = "1.0.0")]
293 impl<T> !Sync for Cell<T> {}
295 #[stable(feature = "rust1", since = "1.0.0")]
296 impl<T:Copy> Clone for Cell<T> {
298 fn clone(&self) -> Cell<T> {
299 Cell::new(self.get())
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.
307 fn default() -> Cell<T> {
308 Cell::new(Default::default())
312 #[stable(feature = "rust1", since = "1.0.0")]
313 impl<T:PartialEq + Copy> PartialEq for Cell<T> {
315 fn eq(&self, other: &Cell<T>) -> bool {
316 self.get() == other.get()
320 #[stable(feature = "cell_eq", since = "1.2.0")]
321 impl<T:Eq + Copy> Eq for Cell<T> {}
323 #[stable(feature = "cell_ord", since = "1.10.0")]
324 impl<T:PartialOrd + Copy> PartialOrd for Cell<T> {
326 fn partial_cmp(&self, other: &Cell<T>) -> Option<Ordering> {
327 self.get().partial_cmp(&other.get())
331 fn lt(&self, other: &Cell<T>) -> bool {
332 self.get() < other.get()
336 fn le(&self, other: &Cell<T>) -> bool {
337 self.get() <= other.get()
341 fn gt(&self, other: &Cell<T>) -> bool {
342 self.get() > other.get()
346 fn ge(&self, other: &Cell<T>) -> bool {
347 self.get() >= other.get()
351 #[stable(feature = "cell_ord", since = "1.10.0")]
352 impl<T:Ord + Copy> Ord for Cell<T> {
354 fn cmp(&self, other: &Cell<T>) -> Ordering {
355 self.get().cmp(&other.get())
359 #[stable(feature = "cell_from", since = "1.12.0")]
360 impl<T> From<T> for Cell<T> {
361 fn from(t: T) -> Cell<T> {
367 /// Creates a new `Cell` containing the given value.
372 /// use std::cell::Cell;
374 /// let c = Cell::new(5);
376 #[stable(feature = "rust1", since = "1.0.0")]
378 pub const fn new(value: T) -> Cell<T> {
380 value: UnsafeCell::new(value),
384 /// Returns a raw pointer to the underlying data in this cell.
389 /// use std::cell::Cell;
391 /// let c = Cell::new(5);
393 /// let ptr = c.as_ptr();
396 #[stable(feature = "cell_as_ptr", since = "1.12.0")]
397 pub fn as_ptr(&self) -> *mut T {
401 /// Returns a mutable reference to the underlying data.
403 /// This call borrows `Cell` mutably (at compile-time) which guarantees
404 /// that we possess the only reference.
409 /// use std::cell::Cell;
411 /// let mut c = Cell::new(5);
412 /// *c.get_mut() += 1;
414 /// assert_eq!(c.get(), 6);
417 #[stable(feature = "cell_get_mut", since = "1.11.0")]
418 pub fn get_mut(&mut self) -> &mut T {
420 &mut *self.value.get()
424 /// Sets the contained value.
429 /// use std::cell::Cell;
431 /// let c = Cell::new(5);
436 #[stable(feature = "rust1", since = "1.0.0")]
437 pub fn set(&self, val: T) {
438 let old = self.replace(val);
442 /// Swaps the values of two Cells.
443 /// Difference with `std::mem::swap` is that this function doesn't require `&mut` reference.
448 /// use std::cell::Cell;
450 /// let c1 = Cell::new(5i32);
451 /// let c2 = Cell::new(10i32);
453 /// assert_eq!(10, c1.get());
454 /// assert_eq!(5, c2.get());
457 #[stable(feature = "move_cell", since = "1.17.0")]
458 pub fn swap(&self, other: &Self) {
459 if ptr::eq(self, other) {
463 ptr::swap(self.value.get(), other.value.get());
467 /// Replaces the contained value, and returns it.
472 /// use std::cell::Cell;
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);
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)
484 /// Unwraps the value.
489 /// use std::cell::Cell;
491 /// let c = Cell::new(5);
492 /// let five = c.into_inner();
494 /// assert_eq!(five, 5);
496 #[stable(feature = "move_cell", since = "1.17.0")]
497 pub fn into_inner(self) -> T {
498 self.value.into_inner()
502 impl<T: Default> Cell<T> {
503 /// Takes the value of the cell, leaving `Default::default()` in its place.
508 /// use std::cell::Cell;
510 /// let c = Cell::new(5);
511 /// let five = c.take();
513 /// assert_eq!(five, 5);
514 /// assert_eq!(c.into_inner(), 0);
516 #[stable(feature = "move_cell", since = "1.17.0")]
517 pub fn take(&self) -> T {
518 self.replace(Default::default())
522 #[unstable(feature = "coerce_unsized", issue = "27732")]
523 impl<T: CoerceUnsized<U>, U> CoerceUnsized<Cell<U>> for Cell<T> {}
525 /// A mutable memory location with dynamically checked borrow rules
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>,
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 {
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()
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)
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 {
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()
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)
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).
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;
591 fn is_writing(x: BorrowFlag) -> bool {
596 fn is_reading(x: BorrowFlag) -> bool {
601 /// Creates a new `RefCell` containing `value`.
606 /// use std::cell::RefCell;
608 /// let c = RefCell::new(5);
610 #[stable(feature = "rust1", since = "1.0.0")]
612 pub const fn new(value: T) -> RefCell<T> {
614 value: UnsafeCell::new(value),
615 borrow: Cell::new(UNUSED),
619 /// Consumes the `RefCell`, returning the wrapped value.
624 /// use std::cell::RefCell;
626 /// let c = RefCell::new(5);
628 /// let five = c.into_inner();
630 #[stable(feature = "rust1", since = "1.0.0")]
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()
640 /// Replaces the wrapped value with a new one, returning the old value,
641 /// without deinitializing either one.
643 /// This function corresponds to [`std::mem::replace`](../mem/fn.replace.html).
647 /// Panics if the value is currently borrowed.
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));
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)
664 /// Replaces the wrapped value with a new one computed from `f`, returning
665 /// the old value, without deinitializing either one.
667 /// This function corresponds to [`std::mem::replace`](../mem/fn.replace.html).
671 /// Panics if the value is currently borrowed.
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));
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)
691 /// Swaps the wrapped value of `self` with the wrapped value of `other`,
692 /// without deinitializing either one.
694 /// This function corresponds to [`std::mem::swap`](../mem/fn.swap.html).
698 /// Panics if the value in either `RefCell` is currently borrowed.
703 /// use std::cell::RefCell;
704 /// let c = RefCell::new(5);
705 /// let d = RefCell::new(6);
707 /// assert_eq!(c, RefCell::new(6));
708 /// assert_eq!(d, RefCell::new(5));
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())
717 impl<T: ?Sized> RefCell<T> {
718 /// Immutably borrows the wrapped value.
720 /// The borrow lasts until the returned `Ref` exits scope. Multiple
721 /// immutable borrows can be taken out at the same time.
725 /// Panics if the value is currently mutably borrowed. For a non-panicking variant, use
726 /// [`try_borrow`](#method.try_borrow).
731 /// use std::cell::RefCell;
733 /// let c = RefCell::new(5);
735 /// let borrowed_five = c.borrow();
736 /// let borrowed_five2 = c.borrow();
739 /// An example of panic:
742 /// use std::cell::RefCell;
745 /// let result = thread::spawn(move || {
746 /// let c = RefCell::new(5);
747 /// let m = c.borrow_mut();
749 /// let b = c.borrow(); // this causes a panic
752 /// assert!(result.is_err());
754 #[stable(feature = "rust1", since = "1.0.0")]
756 pub fn borrow(&self) -> Ref<T> {
757 self.try_borrow().expect("already mutably borrowed")
760 /// Immutably borrows the wrapped value, returning an error if the value is currently mutably
763 /// The borrow lasts until the returned `Ref` exits scope. Multiple immutable borrows can be
764 /// taken out at the same time.
766 /// This is the non-panicking variant of [`borrow`](#method.borrow).
771 /// use std::cell::RefCell;
773 /// let c = RefCell::new(5);
776 /// let m = c.borrow_mut();
777 /// assert!(c.try_borrow().is_err());
781 /// let m = c.borrow();
782 /// assert!(c.try_borrow().is_ok());
785 #[stable(feature = "try_borrow", since = "1.13.0")]
787 pub fn try_borrow(&self) -> Result<Ref<T>, BorrowError> {
788 match BorrowRef::new(&self.borrow) {
790 value: unsafe { &*self.value.get() },
793 None => Err(BorrowError { _private: () }),
797 /// Mutably borrows the wrapped value.
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
805 /// Panics if the value is currently borrowed. For a non-panicking variant, use
806 /// [`try_borrow_mut`](#method.try_borrow_mut).
811 /// use std::cell::RefCell;
813 /// let c = RefCell::new(5);
815 /// *c.borrow_mut() = 7;
817 /// assert_eq!(*c.borrow(), 7);
820 /// An example of panic:
823 /// use std::cell::RefCell;
826 /// let result = thread::spawn(move || {
827 /// let c = RefCell::new(5);
828 /// let m = c.borrow();
830 /// let b = c.borrow_mut(); // this causes a panic
833 /// assert!(result.is_err());
835 #[stable(feature = "rust1", since = "1.0.0")]
837 pub fn borrow_mut(&self) -> RefMut<T> {
838 self.try_borrow_mut().expect("already borrowed")
841 /// Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
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
847 /// This is the non-panicking variant of [`borrow_mut`](#method.borrow_mut).
852 /// use std::cell::RefCell;
854 /// let c = RefCell::new(5);
857 /// let m = c.borrow();
858 /// assert!(c.try_borrow_mut().is_err());
861 /// assert!(c.try_borrow_mut().is_ok());
863 #[stable(feature = "try_borrow", since = "1.13.0")]
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() },
871 None => Err(BorrowMutError { _private: () }),
875 /// Returns a raw pointer to the underlying data in this cell.
880 /// use std::cell::RefCell;
882 /// let c = RefCell::new(5);
884 /// let ptr = c.as_ptr();
887 #[stable(feature = "cell_as_ptr", since = "1.12.0")]
888 pub fn as_ptr(&self) -> *mut T {
892 /// Returns a mutable reference to the underlying data.
894 /// This call borrows `RefCell` mutably (at compile-time) so there is no
895 /// need for dynamic checks.
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.
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.
904 /// [`borrow_mut`]: #method.borrow_mut
909 /// use std::cell::RefCell;
911 /// let mut c = RefCell::new(5);
912 /// *c.get_mut() += 1;
914 /// assert_eq!(c, RefCell::new(6));
917 #[stable(feature = "cell_get_mut", since = "1.11.0")]
918 pub fn get_mut(&mut self) -> &mut T {
920 &mut *self.value.get()
925 #[stable(feature = "rust1", since = "1.0.0")]
926 unsafe impl<T: ?Sized> Send for RefCell<T> where T: Send {}
928 #[stable(feature = "rust1", since = "1.0.0")]
929 impl<T: ?Sized> !Sync for RefCell<T> {}
931 #[stable(feature = "rust1", since = "1.0.0")]
932 impl<T: Clone> Clone for RefCell<T> {
935 /// Panics if the value is currently mutably borrowed.
937 fn clone(&self) -> RefCell<T> {
938 RefCell::new(self.borrow().clone())
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.
946 fn default() -> RefCell<T> {
947 RefCell::new(Default::default())
951 #[stable(feature = "rust1", since = "1.0.0")]
952 impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> {
955 /// Panics if the value in either `RefCell` is currently borrowed.
957 fn eq(&self, other: &RefCell<T>) -> bool {
958 *self.borrow() == *other.borrow()
962 #[stable(feature = "cell_eq", since = "1.2.0")]
963 impl<T: ?Sized + Eq> Eq for RefCell<T> {}
965 #[stable(feature = "cell_ord", since = "1.10.0")]
966 impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
969 /// Panics if the value in either `RefCell` is currently borrowed.
971 fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> {
972 self.borrow().partial_cmp(&*other.borrow())
977 /// Panics if the value in either `RefCell` is currently borrowed.
979 fn lt(&self, other: &RefCell<T>) -> bool {
980 *self.borrow() < *other.borrow()
985 /// Panics if the value in either `RefCell` is currently borrowed.
987 fn le(&self, other: &RefCell<T>) -> bool {
988 *self.borrow() <= *other.borrow()
993 /// Panics if the value in either `RefCell` is currently borrowed.
995 fn gt(&self, other: &RefCell<T>) -> bool {
996 *self.borrow() > *other.borrow()
1001 /// Panics if the value in either `RefCell` is currently borrowed.
1003 fn ge(&self, other: &RefCell<T>) -> bool {
1004 *self.borrow() >= *other.borrow()
1008 #[stable(feature = "cell_ord", since = "1.10.0")]
1009 impl<T: ?Sized + Ord> Ord for RefCell<T> {
1012 /// Panics if the value in either `RefCell` is currently borrowed.
1014 fn cmp(&self, other: &RefCell<T>) -> Ordering {
1015 self.borrow().cmp(&*other.borrow())
1019 #[stable(feature = "cell_from", since = "1.12.0")]
1020 impl<T> From<T> for RefCell<T> {
1021 fn from(t: T) -> RefCell<T> {
1026 #[unstable(feature = "coerce_unsized", issue = "27732")]
1027 impl<T: CoerceUnsized<U>, U> CoerceUnsized<RefCell<U>> for RefCell<T> {}
1029 struct BorrowRef<'b> {
1030 borrow: &'b Cell<BorrowFlag>,
1033 impl<'b> BorrowRef<'b> {
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.
1043 Some(BorrowRef { borrow })
1048 impl<'b> Drop for BorrowRef<'b> {
1050 fn drop(&mut self) {
1051 let borrow = self.borrow.get();
1052 debug_assert!(is_reading(borrow));
1053 self.borrow.set(borrow - 1);
1057 impl<'b> Clone for BorrowRef<'b> {
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 }
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>`.
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> {
1079 borrow: BorrowRef<'b>,
1082 #[stable(feature = "rust1", since = "1.0.0")]
1083 impl<'b, T: ?Sized> Deref for Ref<'b, T> {
1087 fn deref(&self) -> &T {
1092 impl<'b, T: ?Sized> Ref<'b, T> {
1095 /// The `RefCell` is already immutably borrowed, so this cannot fail.
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
1101 #[stable(feature = "cell_extras", since = "1.15.0")]
1103 pub fn clone(orig: &Ref<'b, T>) -> Ref<'b, T> {
1106 borrow: orig.borrow.clone(),
1110 /// Make a new `Ref` for a component of the borrowed data.
1112 /// The `RefCell` is already immutably borrowed, so this cannot fail.
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`.
1121 /// use std::cell::{RefCell, Ref};
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)
1128 #[stable(feature = "cell_map", since = "1.8.0")]
1130 pub fn map<U: ?Sized, F>(orig: Ref<'b, T>, f: F) -> Ref<'b, U>
1131 where F: FnOnce(&T) -> &U
1134 value: f(orig.value),
1135 borrow: orig.borrow,
1139 /// Split a `Ref` into multiple `Ref`s for different components of the
1142 /// The `RefCell` is already immutably borrowed, so this cannot fail.
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`.
1151 /// #![feature(refcell_map_split)]
1152 /// use std::cell::{Ref, RefCell};
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]);
1160 #[unstable(feature = "refcell_map_split", issue = "51476")]
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)
1165 let (a, b) = f(orig.value);
1166 let borrow = orig.borrow.clone();
1167 (Ref { value: a, borrow }, Ref { value: b, borrow: orig.borrow })
1171 #[unstable(feature = "coerce_unsized", issue = "27732")]
1172 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Ref<'b, U>> for Ref<'b, T> {}
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 {
1181 impl<'b, T: ?Sized> RefMut<'b, T> {
1182 /// Make a new `RefMut` for a component of the borrowed data, e.g. an enum
1185 /// The `RefCell` is already mutably borrowed, so this cannot fail.
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`.
1194 /// use std::cell::{RefCell, RefMut};
1196 /// let c = RefCell::new((5, 'b'));
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);
1203 /// assert_eq!(*c.borrow(), (42, 'b'));
1205 #[stable(feature = "cell_map", since = "1.8.0")]
1207 pub fn map<U: ?Sized, F>(orig: RefMut<'b, T>, f: F) -> RefMut<'b, U>
1208 where F: FnOnce(&mut T) -> &mut U
1210 // FIXME(nll-rfc#40): fix borrow-check
1211 let RefMut { value, borrow } = orig;
1218 /// Split a `RefMut` into multiple `RefMut`s for different components of the
1221 /// The underlying `RefCell` will remain mutably borrowed until both
1222 /// returned `RefMut`s go out of scope.
1224 /// The `RefCell` is already mutably borrowed, so this cannot fail.
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`.
1233 /// #![feature(refcell_map_split)]
1234 /// use std::cell::{RefCell, RefMut};
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]);
1244 #[unstable(feature = "refcell_map_split", issue = "51476")]
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)
1251 let (a, b) = f(orig.value);
1252 let borrow = orig.borrow.clone();
1253 (RefMut { value: a, borrow }, RefMut { value: b, borrow: orig.borrow })
1257 struct BorrowRefMut<'b> {
1258 borrow: &'b Cell<BorrowFlag>,
1261 impl<'b> Drop for BorrowRefMut<'b> {
1263 fn drop(&mut self) {
1264 let borrow = self.borrow.get();
1265 debug_assert!(is_writing(borrow));
1266 self.borrow.set(borrow + 1);
1270 impl<'b> BorrowRefMut<'b> {
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() {
1279 borrow.set(UNUSED - 1);
1280 Some(BorrowRefMut { borrow: borrow })
1286 // Clone a `BorrowRefMut`.
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.
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 }
1302 /// A wrapper type for a mutably borrowed value from a `RefCell<T>`.
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> {
1308 borrow: BorrowRefMut<'b>,
1311 #[stable(feature = "rust1", since = "1.0.0")]
1312 impl<'b, T: ?Sized> Deref for RefMut<'b, T> {
1316 fn deref(&self) -> &T {
1321 #[stable(feature = "rust1", since = "1.0.0")]
1322 impl<'b, T: ?Sized> DerefMut for RefMut<'b, T> {
1324 fn deref_mut(&mut self) -> &mut T {
1329 #[unstable(feature = "coerce_unsized", issue = "27732")]
1330 impl<'b, T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<RefMut<'b, U>> for RefMut<'b, T> {}
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 {
1339 /// The core primitive for interior mutability in Rust.
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.
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.
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.
1355 /// The precise Rust aliasing rules are somewhat in flux, but the main points are not contentious:
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.
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).
1371 /// To assist with proper design, the following scenarios are explicitly declared legal
1372 /// for single-threaded code:
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`
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.
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.
1387 /// use std::cell::UnsafeCell;
1388 /// use std::marker::Sync;
1390 /// # #[allow(dead_code)]
1391 /// struct NotThreadSafe<T> {
1392 /// value: UnsafeCell<T>,
1395 /// unsafe impl<T> Sync for NotThreadSafe<T> {}
1397 #[lang = "unsafe_cell"]
1398 #[stable(feature = "rust1", since = "1.0.0")]
1399 #[repr(transparent)]
1400 pub struct UnsafeCell<T: ?Sized> {
1404 #[stable(feature = "rust1", since = "1.0.0")]
1405 impl<T: ?Sized> !Sync for UnsafeCell<T> {}
1407 impl<T> UnsafeCell<T> {
1408 /// Constructs a new instance of `UnsafeCell` which will wrap the specified
1411 /// All access to the inner value through methods is `unsafe`.
1416 /// use std::cell::UnsafeCell;
1418 /// let uc = UnsafeCell::new(5);
1420 #[stable(feature = "rust1", since = "1.0.0")]
1422 pub const fn new(value: T) -> UnsafeCell<T> {
1423 UnsafeCell { value: value }
1426 /// Unwraps the value.
1431 /// use std::cell::UnsafeCell;
1433 /// let uc = UnsafeCell::new(5);
1435 /// let five = uc.into_inner();
1438 #[stable(feature = "rust1", since = "1.0.0")]
1439 pub fn into_inner(self) -> T {
1444 impl<T: ?Sized> UnsafeCell<T> {
1445 /// Gets a mutable pointer to the wrapped value.
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`
1455 /// use std::cell::UnsafeCell;
1457 /// let uc = UnsafeCell::new(5);
1459 /// let five = uc.get();
1462 #[stable(feature = "rust1", since = "1.0.0")]
1463 pub fn get(&self) -> *mut T {
1464 &self.value as *const T as *mut T
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())
1476 #[stable(feature = "cell_from", since = "1.12.0")]
1477 impl<T> From<T> for UnsafeCell<T> {
1478 fn from(t: T) -> UnsafeCell<T> {
1483 #[unstable(feature = "coerce_unsized", issue = "27732")]
1484 impl<T: CoerceUnsized<U>, U> CoerceUnsized<UnsafeCell<U>> for UnsafeCell<T> {}
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;