1 //! Single-threaded reference-counting pointers. 'Rc' stands for 'Reference
4 //! The type [`Rc<T>`][`Rc`] provides shared ownership of a value of type `T`,
5 //! allocated in the heap. Invoking [`clone`][clone] on [`Rc`] produces a new
6 //! pointer to the same allocation in the heap. When the last [`Rc`] pointer to a
7 //! given allocation is destroyed, the value stored in that allocation (often
8 //! referred to as "inner value") is also dropped.
10 //! Shared references in Rust disallow mutation by default, and [`Rc`]
11 //! is no exception: you cannot generally obtain a mutable reference to
12 //! something inside an [`Rc`]. If you need mutability, put a [`Cell`]
13 //! or [`RefCell`] inside the [`Rc`]; see [an example of mutability
14 //! inside an `Rc`][mutability].
16 //! [`Rc`] uses non-atomic reference counting. This means that overhead is very
17 //! low, but an [`Rc`] cannot be sent between threads, and consequently [`Rc`]
18 //! does not implement [`Send`][send]. As a result, the Rust compiler
19 //! will check *at compile time* that you are not sending [`Rc`]s between
20 //! threads. If you need multi-threaded, atomic reference counting, use
21 //! [`sync::Arc`][arc].
23 //! The [`downgrade`][downgrade] method can be used to create a non-owning
24 //! [`Weak`] pointer. A [`Weak`] pointer can be [`upgrade`][upgrade]d
25 //! to an [`Rc`], but this will return [`None`] if the value stored in the allocation has
26 //! already been dropped. In other words, `Weak` pointers do not keep the value
27 //! inside the allocation alive; however, they *do* keep the allocation
28 //! (the backing store for the inner value) alive.
30 //! A cycle between [`Rc`] pointers will never be deallocated. For this reason,
31 //! [`Weak`] is used to break cycles. For example, a tree could have strong
32 //! [`Rc`] pointers from parent nodes to children, and [`Weak`] pointers from
33 //! children back to their parents.
35 //! `Rc<T>` automatically dereferences to `T` (via the [`Deref`] trait),
36 //! so you can call `T`'s methods on a value of type [`Rc<T>`][`Rc`]. To avoid name
37 //! clashes with `T`'s methods, the methods of [`Rc<T>`][`Rc`] itself are associated
38 //! functions, called using [fully qualified syntax]:
43 //! let my_rc = Rc::new(());
44 //! let my_weak = Rc::downgrade(&my_rc);
47 //! `Rc<T>`'s implementations of traits like `Clone` may also be called using
48 //! fully qualified syntax. Some people prefer to use fully qualified syntax,
49 //! while others prefer using method-call syntax.
54 //! let rc = Rc::new(());
55 //! // Method-call syntax
56 //! let rc2 = rc.clone();
57 //! // Fully qualified syntax
58 //! let rc3 = Rc::clone(&rc);
61 //! [`Weak<T>`][`Weak`] does not auto-dereference to `T`, because the inner value may have
62 //! already been dropped.
64 //! # Cloning references
66 //! Creating a new reference to the same allocation as an existing reference counted pointer
67 //! is done using the `Clone` trait implemented for [`Rc<T>`][`Rc`] and [`Weak<T>`][`Weak`].
72 //! let foo = Rc::new(vec![1.0, 2.0, 3.0]);
73 //! // The two syntaxes below are equivalent.
74 //! let a = foo.clone();
75 //! let b = Rc::clone(&foo);
76 //! // a and b both point to the same memory location as foo.
79 //! The `Rc::clone(&from)` syntax is the most idiomatic because it conveys more explicitly
80 //! the meaning of the code. In the example above, this syntax makes it easier to see that
81 //! this code is creating a new reference rather than copying the whole content of foo.
85 //! Consider a scenario where a set of `Gadget`s are owned by a given `Owner`.
86 //! We want to have our `Gadget`s point to their `Owner`. We can't do this with
87 //! unique ownership, because more than one gadget may belong to the same
88 //! `Owner`. [`Rc`] allows us to share an `Owner` between multiple `Gadget`s,
89 //! and have the `Owner` remain allocated as long as any `Gadget` points at it.
96 //! // ...other fields
101 //! owner: Rc<Owner>,
102 //! // ...other fields
106 //! // Create a reference-counted `Owner`.
107 //! let gadget_owner: Rc<Owner> = Rc::new(
109 //! name: "Gadget Man".to_string(),
113 //! // Create `Gadget`s belonging to `gadget_owner`. Cloning the `Rc<Owner>`
114 //! // gives us a new pointer to the same `Owner` allocation, incrementing
115 //! // the reference count in the process.
116 //! let gadget1 = Gadget {
118 //! owner: Rc::clone(&gadget_owner),
120 //! let gadget2 = Gadget {
122 //! owner: Rc::clone(&gadget_owner),
125 //! // Dispose of our local variable `gadget_owner`.
126 //! drop(gadget_owner);
128 //! // Despite dropping `gadget_owner`, we're still able to print out the name
129 //! // of the `Owner` of the `Gadget`s. This is because we've only dropped a
130 //! // single `Rc<Owner>`, not the `Owner` it points to. As long as there are
131 //! // other `Rc<Owner>` pointing at the same `Owner` allocation, it will remain
132 //! // live. The field projection `gadget1.owner.name` works because
133 //! // `Rc<Owner>` automatically dereferences to `Owner`.
134 //! println!("Gadget {} owned by {}", gadget1.id, gadget1.owner.name);
135 //! println!("Gadget {} owned by {}", gadget2.id, gadget2.owner.name);
137 //! // At the end of the function, `gadget1` and `gadget2` are destroyed, and
138 //! // with them the last counted references to our `Owner`. Gadget Man now
139 //! // gets destroyed as well.
143 //! If our requirements change, and we also need to be able to traverse from
144 //! `Owner` to `Gadget`, we will run into problems. An [`Rc`] pointer from `Owner`
145 //! to `Gadget` introduces a cycle. This means that their
146 //! reference counts can never reach 0, and the allocation will never be destroyed:
147 //! a memory leak. In order to get around this, we can use [`Weak`]
150 //! Rust actually makes it somewhat difficult to produce this loop in the first
151 //! place. In order to end up with two values that point at each other, one of
152 //! them needs to be mutable. This is difficult because [`Rc`] enforces
153 //! memory safety by only giving out shared references to the value it wraps,
154 //! and these don't allow direct mutation. We need to wrap the part of the
155 //! value we wish to mutate in a [`RefCell`], which provides *interior
156 //! mutability*: a method to achieve mutability through a shared reference.
157 //! [`RefCell`] enforces Rust's borrowing rules at runtime.
161 //! use std::rc::Weak;
162 //! use std::cell::RefCell;
166 //! gadgets: RefCell<Vec<Weak<Gadget>>>,
167 //! // ...other fields
172 //! owner: Rc<Owner>,
173 //! // ...other fields
177 //! // Create a reference-counted `Owner`. Note that we've put the `Owner`'s
178 //! // vector of `Gadget`s inside a `RefCell` so that we can mutate it through
179 //! // a shared reference.
180 //! let gadget_owner: Rc<Owner> = Rc::new(
182 //! name: "Gadget Man".to_string(),
183 //! gadgets: RefCell::new(vec![]),
187 //! // Create `Gadget`s belonging to `gadget_owner`, as before.
188 //! let gadget1 = Rc::new(
191 //! owner: Rc::clone(&gadget_owner),
194 //! let gadget2 = Rc::new(
197 //! owner: Rc::clone(&gadget_owner),
201 //! // Add the `Gadget`s to their `Owner`.
203 //! let mut gadgets = gadget_owner.gadgets.borrow_mut();
204 //! gadgets.push(Rc::downgrade(&gadget1));
205 //! gadgets.push(Rc::downgrade(&gadget2));
207 //! // `RefCell` dynamic borrow ends here.
210 //! // Iterate over our `Gadget`s, printing their details out.
211 //! for gadget_weak in gadget_owner.gadgets.borrow().iter() {
213 //! // `gadget_weak` is a `Weak<Gadget>`. Since `Weak` pointers can't
214 //! // guarantee the allocation still exists, we need to call
215 //! // `upgrade`, which returns an `Option<Rc<Gadget>>`.
217 //! // In this case we know the allocation still exists, so we simply
218 //! // `unwrap` the `Option`. In a more complicated program, you might
219 //! // need graceful error handling for a `None` result.
221 //! let gadget = gadget_weak.upgrade().unwrap();
222 //! println!("Gadget {} owned by {}", gadget.id, gadget.owner.name);
225 //! // At the end of the function, `gadget_owner`, `gadget1`, and `gadget2`
226 //! // are destroyed. There are now no strong (`Rc`) pointers to the
227 //! // gadgets, so they are destroyed. This zeroes the reference count on
228 //! // Gadget Man, so he gets destroyed as well.
232 //! [clone]: Clone::clone
233 //! [`Cell`]: core::cell::Cell
234 //! [`RefCell`]: core::cell::RefCell
235 //! [send]: core::marker::Send
236 //! [arc]: crate::sync::Arc
237 //! [`Deref`]: core::ops::Deref
238 //! [downgrade]: Rc::downgrade
239 //! [upgrade]: Weak::upgrade
240 //! [mutability]: core::cell#introducing-mutability-inside-of-something-immutable
241 //! [fully qualified syntax]: https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name
243 #![stable(feature = "rust1", since = "1.0.0")]
246 use crate::boxed::Box;
252 use core::cell::Cell;
253 use core::cmp::Ordering;
254 use core::convert::{From, TryFrom};
256 use core::hash::{Hash, Hasher};
257 use core::intrinsics::abort;
258 #[cfg(not(no_global_oom_handling))]
260 use core::marker::{self, PhantomData, Unpin, Unsize};
261 #[cfg(not(no_global_oom_handling))]
262 use core::mem::size_of_val;
263 use core::mem::{self, align_of_val_raw, forget};
264 use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
265 use core::panic::{RefUnwindSafe, UnwindSafe};
266 #[cfg(not(no_global_oom_handling))]
268 use core::ptr::{self, NonNull};
269 #[cfg(not(no_global_oom_handling))]
270 use core::slice::from_raw_parts_mut;
272 #[cfg(not(no_global_oom_handling))]
273 use crate::alloc::handle_alloc_error;
274 #[cfg(not(no_global_oom_handling))]
275 use crate::alloc::{box_free, WriteCloneIntoRaw};
276 use crate::alloc::{AllocError, Allocator, Global, Layout};
277 use crate::borrow::{Cow, ToOwned};
278 #[cfg(not(no_global_oom_handling))]
279 use crate::string::String;
280 #[cfg(not(no_global_oom_handling))]
286 // This is repr(C) to future-proof against possible field-reordering, which
287 // would interfere with otherwise safe [into|from]_raw() of transmutable
290 struct RcBox<T: ?Sized> {
296 /// A single-threaded reference-counting pointer. 'Rc' stands for 'Reference
299 /// See the [module-level documentation](./index.html) for more details.
301 /// The inherent methods of `Rc` are all associated functions, which means
302 /// that you have to call them as e.g., [`Rc::get_mut(&mut value)`][get_mut] instead of
303 /// `value.get_mut()`. This avoids conflicts with methods of the inner type `T`.
305 /// [get_mut]: Rc::get_mut
306 #[cfg_attr(not(test), rustc_diagnostic_item = "Rc")]
307 #[stable(feature = "rust1", since = "1.0.0")]
308 #[rustc_insignificant_dtor]
309 pub struct Rc<T: ?Sized> {
310 ptr: NonNull<RcBox<T>>,
311 phantom: PhantomData<RcBox<T>>,
314 #[stable(feature = "rust1", since = "1.0.0")]
315 impl<T: ?Sized> !marker::Send for Rc<T> {}
317 // Note that this negative impl isn't strictly necessary for correctness,
318 // as `Rc` transitively contains a `Cell`, which is itself `!Sync`.
319 // However, given how important `Rc`'s `!Sync`-ness is,
320 // having an explicit negative impl is nice for documentation purposes
321 // and results in nicer error messages.
322 #[stable(feature = "rust1", since = "1.0.0")]
323 impl<T: ?Sized> !marker::Sync for Rc<T> {}
325 #[stable(feature = "catch_unwind", since = "1.9.0")]
326 impl<T: RefUnwindSafe + ?Sized> UnwindSafe for Rc<T> {}
327 #[stable(feature = "rc_ref_unwind_safe", since = "1.58.0")]
328 impl<T: RefUnwindSafe + ?Sized> RefUnwindSafe for Rc<T> {}
330 #[unstable(feature = "coerce_unsized", issue = "27732")]
331 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Rc<U>> for Rc<T> {}
333 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
334 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Rc<U>> for Rc<T> {}
336 impl<T: ?Sized> Rc<T> {
338 fn inner(&self) -> &RcBox<T> {
339 // This unsafety is ok because while this Rc is alive we're guaranteed
340 // that the inner pointer is valid.
341 unsafe { self.ptr.as_ref() }
344 unsafe fn from_inner(ptr: NonNull<RcBox<T>>) -> Self {
345 Self { ptr, phantom: PhantomData }
348 unsafe fn from_ptr(ptr: *mut RcBox<T>) -> Self {
349 unsafe { Self::from_inner(NonNull::new_unchecked(ptr)) }
354 /// Constructs a new `Rc<T>`.
361 /// let five = Rc::new(5);
363 #[cfg(not(no_global_oom_handling))]
364 #[stable(feature = "rust1", since = "1.0.0")]
365 pub fn new(value: T) -> Rc<T> {
366 // There is an implicit weak pointer owned by all the strong
367 // pointers, which ensures that the weak destructor never frees
368 // the allocation while the strong destructor is running, even
369 // if the weak pointer is stored inside the strong one.
372 Box::leak(box RcBox { strong: Cell::new(1), weak: Cell::new(1), value }).into(),
377 /// Constructs a new `Rc<T>` using a closure `data_fn` that has access to a
378 /// weak reference to the constructing `Rc<T>`.
380 /// Generally, a structure circularly referencing itself, either directly or
381 /// indirectly, should not hold a strong reference to prevent a memory leak.
382 /// In `data_fn`, initialization of `T` can make use of the weak reference
383 /// by cloning and storing it inside `T` for use at a later time.
385 /// Since the new `Rc<T>` is not fully-constructed until `Rc<T>::new_cyclic`
386 /// returns, calling [`upgrade`] on the weak reference inside `data_fn` will
387 /// fail and result in a `None` value.
390 /// If `data_fn` panics, the panic is propagated to the caller, and the
391 /// temporary [`Weak<T>`] is dropped normally.
396 /// # #![allow(dead_code)]
397 /// use std::rc::{Rc, Weak};
400 /// me: Weak<Gadget>,
404 /// /// Construct a reference counted Gadget.
405 /// fn new() -> Rc<Self> {
406 /// Rc::new_cyclic(|me| Gadget { me: me.clone() })
409 /// /// Return a reference counted pointer to Self.
410 /// fn me(&self) -> Rc<Self> {
411 /// self.me.upgrade().unwrap()
415 /// [`upgrade`]: Weak::upgrade
416 #[cfg(not(no_global_oom_handling))]
417 #[stable(feature = "arc_new_cyclic", since = "1.60.0")]
418 pub fn new_cyclic<F>(data_fn: F) -> Rc<T>
420 F: FnOnce(&Weak<T>) -> T,
422 // Construct the inner in the "uninitialized" state with a single
424 let uninit_ptr: NonNull<_> = Box::leak(box RcBox {
425 strong: Cell::new(0),
427 value: mem::MaybeUninit::<T>::uninit(),
431 let init_ptr: NonNull<RcBox<T>> = uninit_ptr.cast();
433 let weak = Weak { ptr: init_ptr };
435 // It's important we don't give up ownership of the weak pointer, or
436 // else the memory might be freed by the time `data_fn` returns. If
437 // we really wanted to pass ownership, we could create an additional
438 // weak pointer for ourselves, but this would result in additional
439 // updates to the weak reference count which might not be necessary
441 let data = data_fn(&weak);
443 let strong = unsafe {
444 let inner = init_ptr.as_ptr();
445 ptr::write(ptr::addr_of_mut!((*inner).value), data);
447 let prev_value = (*inner).strong.get();
448 debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
449 (*inner).strong.set(1);
451 Rc::from_inner(init_ptr)
454 // Strong references should collectively own a shared weak reference,
455 // so don't run the destructor for our old weak reference.
460 /// Constructs a new `Rc` with uninitialized contents.
465 /// #![feature(new_uninit)]
466 /// #![feature(get_mut_unchecked)]
470 /// let mut five = Rc::<u32>::new_uninit();
472 /// // Deferred initialization:
473 /// Rc::get_mut(&mut five).unwrap().write(5);
475 /// let five = unsafe { five.assume_init() };
477 /// assert_eq!(*five, 5)
479 #[cfg(not(no_global_oom_handling))]
480 #[unstable(feature = "new_uninit", issue = "63291")]
482 pub fn new_uninit() -> Rc<mem::MaybeUninit<T>> {
484 Rc::from_ptr(Rc::allocate_for_layout(
486 |layout| Global.allocate(layout),
487 |mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
492 /// Constructs a new `Rc` with uninitialized contents, with the memory
493 /// being filled with `0` bytes.
495 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
496 /// incorrect usage of this method.
501 /// #![feature(new_uninit)]
505 /// let zero = Rc::<u32>::new_zeroed();
506 /// let zero = unsafe { zero.assume_init() };
508 /// assert_eq!(*zero, 0)
511 /// [zeroed]: mem::MaybeUninit::zeroed
512 #[cfg(not(no_global_oom_handling))]
513 #[unstable(feature = "new_uninit", issue = "63291")]
515 pub fn new_zeroed() -> Rc<mem::MaybeUninit<T>> {
517 Rc::from_ptr(Rc::allocate_for_layout(
519 |layout| Global.allocate_zeroed(layout),
520 |mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
525 /// Constructs a new `Rc<T>`, returning an error if the allocation fails
530 /// #![feature(allocator_api)]
533 /// let five = Rc::try_new(5);
534 /// # Ok::<(), std::alloc::AllocError>(())
536 #[unstable(feature = "allocator_api", issue = "32838")]
537 pub fn try_new(value: T) -> Result<Rc<T>, AllocError> {
538 // There is an implicit weak pointer owned by all the strong
539 // pointers, which ensures that the weak destructor never frees
540 // the allocation while the strong destructor is running, even
541 // if the weak pointer is stored inside the strong one.
544 Box::leak(Box::try_new(RcBox { strong: Cell::new(1), weak: Cell::new(1), value })?)
550 /// Constructs a new `Rc` with uninitialized contents, returning an error if the allocation fails
555 /// #![feature(allocator_api, new_uninit)]
556 /// #![feature(get_mut_unchecked)]
560 /// let mut five = Rc::<u32>::try_new_uninit()?;
562 /// // Deferred initialization:
563 /// Rc::get_mut(&mut five).unwrap().write(5);
565 /// let five = unsafe { five.assume_init() };
567 /// assert_eq!(*five, 5);
568 /// # Ok::<(), std::alloc::AllocError>(())
570 #[unstable(feature = "allocator_api", issue = "32838")]
571 // #[unstable(feature = "new_uninit", issue = "63291")]
572 pub fn try_new_uninit() -> Result<Rc<mem::MaybeUninit<T>>, AllocError> {
574 Ok(Rc::from_ptr(Rc::try_allocate_for_layout(
576 |layout| Global.allocate(layout),
577 |mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
582 /// Constructs a new `Rc` with uninitialized contents, with the memory
583 /// being filled with `0` bytes, returning an error if the allocation fails
585 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
586 /// incorrect usage of this method.
591 /// #![feature(allocator_api, new_uninit)]
595 /// let zero = Rc::<u32>::try_new_zeroed()?;
596 /// let zero = unsafe { zero.assume_init() };
598 /// assert_eq!(*zero, 0);
599 /// # Ok::<(), std::alloc::AllocError>(())
602 /// [zeroed]: mem::MaybeUninit::zeroed
603 #[unstable(feature = "allocator_api", issue = "32838")]
604 //#[unstable(feature = "new_uninit", issue = "63291")]
605 pub fn try_new_zeroed() -> Result<Rc<mem::MaybeUninit<T>>, AllocError> {
607 Ok(Rc::from_ptr(Rc::try_allocate_for_layout(
609 |layout| Global.allocate_zeroed(layout),
610 |mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
614 /// Constructs a new `Pin<Rc<T>>`. If `T` does not implement `Unpin`, then
615 /// `value` will be pinned in memory and unable to be moved.
616 #[cfg(not(no_global_oom_handling))]
617 #[stable(feature = "pin", since = "1.33.0")]
619 pub fn pin(value: T) -> Pin<Rc<T>> {
620 unsafe { Pin::new_unchecked(Rc::new(value)) }
623 /// Returns the inner value, if the `Rc` has exactly one strong reference.
625 /// Otherwise, an [`Err`] is returned with the same `Rc` that was
628 /// This will succeed even if there are outstanding weak references.
635 /// let x = Rc::new(3);
636 /// assert_eq!(Rc::try_unwrap(x), Ok(3));
638 /// let x = Rc::new(4);
639 /// let _y = Rc::clone(&x);
640 /// assert_eq!(*Rc::try_unwrap(x).unwrap_err(), 4);
643 #[stable(feature = "rc_unique", since = "1.4.0")]
644 pub fn try_unwrap(this: Self) -> Result<T, Self> {
645 if Rc::strong_count(&this) == 1 {
647 let val = ptr::read(&*this); // copy the contained object
649 // Indicate to Weaks that they can't be promoted by decrementing
650 // the strong count, and then remove the implicit "strong weak"
651 // pointer while also handling drop logic by just crafting a
653 this.inner().dec_strong();
654 let _weak = Weak { ptr: this.ptr };
665 /// Constructs a new reference-counted slice with uninitialized contents.
670 /// #![feature(new_uninit)]
671 /// #![feature(get_mut_unchecked)]
675 /// let mut values = Rc::<[u32]>::new_uninit_slice(3);
677 /// // Deferred initialization:
678 /// let data = Rc::get_mut(&mut values).unwrap();
679 /// data[0].write(1);
680 /// data[1].write(2);
681 /// data[2].write(3);
683 /// let values = unsafe { values.assume_init() };
685 /// assert_eq!(*values, [1, 2, 3])
687 #[cfg(not(no_global_oom_handling))]
688 #[unstable(feature = "new_uninit", issue = "63291")]
690 pub fn new_uninit_slice(len: usize) -> Rc<[mem::MaybeUninit<T>]> {
691 unsafe { Rc::from_ptr(Rc::allocate_for_slice(len)) }
694 /// Constructs a new reference-counted slice with uninitialized contents, with the memory being
695 /// filled with `0` bytes.
697 /// See [`MaybeUninit::zeroed`][zeroed] for examples of correct and
698 /// incorrect usage of this method.
703 /// #![feature(new_uninit)]
707 /// let values = Rc::<[u32]>::new_zeroed_slice(3);
708 /// let values = unsafe { values.assume_init() };
710 /// assert_eq!(*values, [0, 0, 0])
713 /// [zeroed]: mem::MaybeUninit::zeroed
714 #[cfg(not(no_global_oom_handling))]
715 #[unstable(feature = "new_uninit", issue = "63291")]
717 pub fn new_zeroed_slice(len: usize) -> Rc<[mem::MaybeUninit<T>]> {
719 Rc::from_ptr(Rc::allocate_for_layout(
720 Layout::array::<T>(len).unwrap(),
721 |layout| Global.allocate_zeroed(layout),
723 ptr::slice_from_raw_parts_mut(mem as *mut T, len)
724 as *mut RcBox<[mem::MaybeUninit<T>]>
731 impl<T> Rc<mem::MaybeUninit<T>> {
732 /// Converts to `Rc<T>`.
736 /// As with [`MaybeUninit::assume_init`],
737 /// it is up to the caller to guarantee that the inner value
738 /// really is in an initialized state.
739 /// Calling this when the content is not yet fully initialized
740 /// causes immediate undefined behavior.
742 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
747 /// #![feature(new_uninit)]
748 /// #![feature(get_mut_unchecked)]
752 /// let mut five = Rc::<u32>::new_uninit();
754 /// // Deferred initialization:
755 /// Rc::get_mut(&mut five).unwrap().write(5);
757 /// let five = unsafe { five.assume_init() };
759 /// assert_eq!(*five, 5)
761 #[unstable(feature = "new_uninit", issue = "63291")]
763 pub unsafe fn assume_init(self) -> Rc<T> {
764 unsafe { Rc::from_inner(mem::ManuallyDrop::new(self).ptr.cast()) }
768 impl<T> Rc<[mem::MaybeUninit<T>]> {
769 /// Converts to `Rc<[T]>`.
773 /// As with [`MaybeUninit::assume_init`],
774 /// it is up to the caller to guarantee that the inner value
775 /// really is in an initialized state.
776 /// Calling this when the content is not yet fully initialized
777 /// causes immediate undefined behavior.
779 /// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
784 /// #![feature(new_uninit)]
785 /// #![feature(get_mut_unchecked)]
789 /// let mut values = Rc::<[u32]>::new_uninit_slice(3);
791 /// // Deferred initialization:
792 /// let data = Rc::get_mut(&mut values).unwrap();
793 /// data[0].write(1);
794 /// data[1].write(2);
795 /// data[2].write(3);
797 /// let values = unsafe { values.assume_init() };
799 /// assert_eq!(*values, [1, 2, 3])
801 #[unstable(feature = "new_uninit", issue = "63291")]
803 pub unsafe fn assume_init(self) -> Rc<[T]> {
804 unsafe { Rc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _) }
808 impl<T: ?Sized> Rc<T> {
809 /// Consumes the `Rc`, returning the wrapped pointer.
811 /// To avoid a memory leak the pointer must be converted back to an `Rc` using
812 /// [`Rc::from_raw`].
819 /// let x = Rc::new("hello".to_owned());
820 /// let x_ptr = Rc::into_raw(x);
821 /// assert_eq!(unsafe { &*x_ptr }, "hello");
823 #[stable(feature = "rc_raw", since = "1.17.0")]
824 pub fn into_raw(this: Self) -> *const T {
825 let ptr = Self::as_ptr(&this);
830 /// Provides a raw pointer to the data.
832 /// The counts are not affected in any way and the `Rc` is not consumed. The pointer is valid
833 /// for as long there are strong counts in the `Rc`.
840 /// let x = Rc::new("hello".to_owned());
841 /// let y = Rc::clone(&x);
842 /// let x_ptr = Rc::as_ptr(&x);
843 /// assert_eq!(x_ptr, Rc::as_ptr(&y));
844 /// assert_eq!(unsafe { &*x_ptr }, "hello");
846 #[stable(feature = "weak_into_raw", since = "1.45.0")]
847 pub fn as_ptr(this: &Self) -> *const T {
848 let ptr: *mut RcBox<T> = NonNull::as_ptr(this.ptr);
850 // SAFETY: This cannot go through Deref::deref or Rc::inner because
851 // this is required to retain raw/mut provenance such that e.g. `get_mut` can
852 // write through the pointer after the Rc is recovered through `from_raw`.
853 unsafe { ptr::addr_of_mut!((*ptr).value) }
856 /// Constructs an `Rc<T>` from a raw pointer.
858 /// The raw pointer must have been previously returned by a call to
859 /// [`Rc<U>::into_raw`][into_raw] where `U` must have the same size
860 /// and alignment as `T`. This is trivially true if `U` is `T`.
861 /// Note that if `U` is not `T` but has the same size and alignment, this is
862 /// basically like transmuting references of different types. See
863 /// [`mem::transmute`] for more information on what
864 /// restrictions apply in this case.
866 /// The user of `from_raw` has to make sure a specific value of `T` is only
869 /// This function is unsafe because improper use may lead to memory unsafety,
870 /// even if the returned `Rc<T>` is never accessed.
872 /// [into_raw]: Rc::into_raw
879 /// let x = Rc::new("hello".to_owned());
880 /// let x_ptr = Rc::into_raw(x);
883 /// // Convert back to an `Rc` to prevent leak.
884 /// let x = Rc::from_raw(x_ptr);
885 /// assert_eq!(&*x, "hello");
887 /// // Further calls to `Rc::from_raw(x_ptr)` would be memory-unsafe.
890 /// // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!
892 #[stable(feature = "rc_raw", since = "1.17.0")]
893 pub unsafe fn from_raw(ptr: *const T) -> Self {
894 let offset = unsafe { data_offset(ptr) };
896 // Reverse the offset to find the original RcBox.
898 unsafe { (ptr as *mut u8).offset(-offset).with_metadata_of(ptr as *mut RcBox<T>) };
900 unsafe { Self::from_ptr(rc_ptr) }
903 /// Creates a new [`Weak`] pointer to this allocation.
910 /// let five = Rc::new(5);
912 /// let weak_five = Rc::downgrade(&five);
914 #[must_use = "this returns a new `Weak` pointer, \
915 without modifying the original `Rc`"]
916 #[stable(feature = "rc_weak", since = "1.4.0")]
917 pub fn downgrade(this: &Self) -> Weak<T> {
918 this.inner().inc_weak();
919 // Make sure we do not create a dangling Weak
920 debug_assert!(!is_dangling(this.ptr.as_ptr()));
921 Weak { ptr: this.ptr }
924 /// Gets the number of [`Weak`] pointers to this allocation.
931 /// let five = Rc::new(5);
932 /// let _weak_five = Rc::downgrade(&five);
934 /// assert_eq!(1, Rc::weak_count(&five));
937 #[stable(feature = "rc_counts", since = "1.15.0")]
938 pub fn weak_count(this: &Self) -> usize {
939 this.inner().weak() - 1
942 /// Gets the number of strong (`Rc`) pointers to this allocation.
949 /// let five = Rc::new(5);
950 /// let _also_five = Rc::clone(&five);
952 /// assert_eq!(2, Rc::strong_count(&five));
955 #[stable(feature = "rc_counts", since = "1.15.0")]
956 pub fn strong_count(this: &Self) -> usize {
957 this.inner().strong()
960 /// Increments the strong reference count on the `Rc<T>` associated with the
961 /// provided pointer by one.
965 /// The pointer must have been obtained through `Rc::into_raw`, and the
966 /// associated `Rc` instance must be valid (i.e. the strong count must be at
967 /// least 1) for the duration of this method.
974 /// let five = Rc::new(5);
977 /// let ptr = Rc::into_raw(five);
978 /// Rc::increment_strong_count(ptr);
980 /// let five = Rc::from_raw(ptr);
981 /// assert_eq!(2, Rc::strong_count(&five));
985 #[stable(feature = "rc_mutate_strong_count", since = "1.53.0")]
986 pub unsafe fn increment_strong_count(ptr: *const T) {
987 // Retain Rc, but don't touch refcount by wrapping in ManuallyDrop
988 let rc = unsafe { mem::ManuallyDrop::new(Rc::<T>::from_raw(ptr)) };
989 // Now increase refcount, but don't drop new refcount either
990 let _rc_clone: mem::ManuallyDrop<_> = rc.clone();
993 /// Decrements the strong reference count on the `Rc<T>` associated with the
994 /// provided pointer by one.
998 /// The pointer must have been obtained through `Rc::into_raw`, and the
999 /// associated `Rc` instance must be valid (i.e. the strong count must be at
1000 /// least 1) when invoking this method. This method can be used to release
1001 /// the final `Rc` and backing storage, but **should not** be called after
1002 /// the final `Rc` has been released.
1007 /// use std::rc::Rc;
1009 /// let five = Rc::new(5);
1012 /// let ptr = Rc::into_raw(five);
1013 /// Rc::increment_strong_count(ptr);
1015 /// let five = Rc::from_raw(ptr);
1016 /// assert_eq!(2, Rc::strong_count(&five));
1017 /// Rc::decrement_strong_count(ptr);
1018 /// assert_eq!(1, Rc::strong_count(&five));
1022 #[stable(feature = "rc_mutate_strong_count", since = "1.53.0")]
1023 pub unsafe fn decrement_strong_count(ptr: *const T) {
1024 unsafe { mem::drop(Rc::from_raw(ptr)) };
1027 /// Returns `true` if there are no other `Rc` or [`Weak`] pointers to
1028 /// this allocation.
1030 fn is_unique(this: &Self) -> bool {
1031 Rc::weak_count(this) == 0 && Rc::strong_count(this) == 1
1034 /// Returns a mutable reference into the given `Rc`, if there are
1035 /// no other `Rc` or [`Weak`] pointers to the same allocation.
1037 /// Returns [`None`] otherwise, because it is not safe to
1038 /// mutate a shared value.
1040 /// See also [`make_mut`][make_mut], which will [`clone`][clone]
1041 /// the inner value when there are other `Rc` pointers.
1043 /// [make_mut]: Rc::make_mut
1044 /// [clone]: Clone::clone
1049 /// use std::rc::Rc;
1051 /// let mut x = Rc::new(3);
1052 /// *Rc::get_mut(&mut x).unwrap() = 4;
1053 /// assert_eq!(*x, 4);
1055 /// let _y = Rc::clone(&x);
1056 /// assert!(Rc::get_mut(&mut x).is_none());
1059 #[stable(feature = "rc_unique", since = "1.4.0")]
1060 pub fn get_mut(this: &mut Self) -> Option<&mut T> {
1061 if Rc::is_unique(this) { unsafe { Some(Rc::get_mut_unchecked(this)) } } else { None }
1064 /// Returns a mutable reference into the given `Rc`,
1065 /// without any check.
1067 /// See also [`get_mut`], which is safe and does appropriate checks.
1069 /// [`get_mut`]: Rc::get_mut
1073 /// Any other `Rc` or [`Weak`] pointers to the same allocation must not be dereferenced
1074 /// for the duration of the returned borrow.
1075 /// This is trivially the case if no such pointers exist,
1076 /// for example immediately after `Rc::new`.
1081 /// #![feature(get_mut_unchecked)]
1083 /// use std::rc::Rc;
1085 /// let mut x = Rc::new(String::new());
1087 /// Rc::get_mut_unchecked(&mut x).push_str("foo")
1089 /// assert_eq!(*x, "foo");
1092 #[unstable(feature = "get_mut_unchecked", issue = "63292")]
1093 pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
1094 // We are careful to *not* create a reference covering the "count" fields, as
1095 // this would conflict with accesses to the reference counts (e.g. by `Weak`).
1096 unsafe { &mut (*this.ptr.as_ptr()).value }
1100 #[stable(feature = "ptr_eq", since = "1.17.0")]
1101 /// Returns `true` if the two `Rc`s point to the same allocation
1102 /// (in a vein similar to [`ptr::eq`]).
1107 /// use std::rc::Rc;
1109 /// let five = Rc::new(5);
1110 /// let same_five = Rc::clone(&five);
1111 /// let other_five = Rc::new(5);
1113 /// assert!(Rc::ptr_eq(&five, &same_five));
1114 /// assert!(!Rc::ptr_eq(&five, &other_five));
1116 pub fn ptr_eq(this: &Self, other: &Self) -> bool {
1117 this.ptr.as_ptr() == other.ptr.as_ptr()
1121 impl<T: Clone> Rc<T> {
1122 /// Makes a mutable reference into the given `Rc`.
1124 /// If there are other `Rc` pointers to the same allocation, then `make_mut` will
1125 /// [`clone`] the inner value to a new allocation to ensure unique ownership. This is also
1126 /// referred to as clone-on-write.
1128 /// However, if there are no other `Rc` pointers to this allocation, but some [`Weak`]
1129 /// pointers, then the [`Weak`] pointers will be disassociated and the inner value will not
1132 /// See also [`get_mut`], which will fail rather than cloning the inner value
1133 /// or diassociating [`Weak`] pointers.
1135 /// [`clone`]: Clone::clone
1136 /// [`get_mut`]: Rc::get_mut
1141 /// use std::rc::Rc;
1143 /// let mut data = Rc::new(5);
1145 /// *Rc::make_mut(&mut data) += 1; // Won't clone anything
1146 /// let mut other_data = Rc::clone(&data); // Won't clone inner data
1147 /// *Rc::make_mut(&mut data) += 1; // Clones inner data
1148 /// *Rc::make_mut(&mut data) += 1; // Won't clone anything
1149 /// *Rc::make_mut(&mut other_data) *= 2; // Won't clone anything
1151 /// // Now `data` and `other_data` point to different allocations.
1152 /// assert_eq!(*data, 8);
1153 /// assert_eq!(*other_data, 12);
1156 /// [`Weak`] pointers will be disassociated:
1159 /// use std::rc::Rc;
1161 /// let mut data = Rc::new(75);
1162 /// let weak = Rc::downgrade(&data);
1164 /// assert!(75 == *data);
1165 /// assert!(75 == *weak.upgrade().unwrap());
1167 /// *Rc::make_mut(&mut data) += 1;
1169 /// assert!(76 == *data);
1170 /// assert!(weak.upgrade().is_none());
1172 #[cfg(not(no_global_oom_handling))]
1174 #[stable(feature = "rc_unique", since = "1.4.0")]
1175 pub fn make_mut(this: &mut Self) -> &mut T {
1176 if Rc::strong_count(this) != 1 {
1177 // Gotta clone the data, there are other Rcs.
1178 // Pre-allocate memory to allow writing the cloned value directly.
1179 let mut rc = Self::new_uninit();
1181 let data = Rc::get_mut_unchecked(&mut rc);
1182 (**this).write_clone_into_raw(data.as_mut_ptr());
1183 *this = rc.assume_init();
1185 } else if Rc::weak_count(this) != 0 {
1186 // Can just steal the data, all that's left is Weaks
1187 let mut rc = Self::new_uninit();
1189 let data = Rc::get_mut_unchecked(&mut rc);
1190 data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
1192 this.inner().dec_strong();
1193 // Remove implicit strong-weak ref (no need to craft a fake
1194 // Weak here -- we know other Weaks can clean up for us)
1195 this.inner().dec_weak();
1196 ptr::write(this, rc.assume_init());
1199 // This unsafety is ok because we're guaranteed that the pointer
1200 // returned is the *only* pointer that will ever be returned to T. Our
1201 // reference count is guaranteed to be 1 at this point, and we required
1202 // the `Rc<T>` itself to be `mut`, so we're returning the only possible
1203 // reference to the allocation.
1204 unsafe { &mut this.ptr.as_mut().value }
1207 /// If we have the only reference to `T` then unwrap it. Otherwise, clone `T` and return the
1210 /// Assuming `rc_t` is of type `Rc<T>`, this function is functionally equivalent to
1211 /// `(*rc_t).clone()`, but will avoid cloning the inner value where possible.
1216 /// #![feature(arc_unwrap_or_clone)]
1217 /// # use std::{ptr, rc::Rc};
1218 /// let inner = String::from("test");
1219 /// let ptr = inner.as_ptr();
1221 /// let rc = Rc::new(inner);
1222 /// let inner = Rc::unwrap_or_clone(rc);
1223 /// // The inner value was not cloned
1224 /// assert!(ptr::eq(ptr, inner.as_ptr()));
1226 /// let rc = Rc::new(inner);
1227 /// let rc2 = rc.clone();
1228 /// let inner = Rc::unwrap_or_clone(rc);
1229 /// // Because there were 2 references, we had to clone the inner value.
1230 /// assert!(!ptr::eq(ptr, inner.as_ptr()));
1231 /// // `rc2` is the last reference, so when we unwrap it we get back
1232 /// // the original `String`.
1233 /// let inner = Rc::unwrap_or_clone(rc2);
1234 /// assert!(ptr::eq(ptr, inner.as_ptr()));
1237 #[unstable(feature = "arc_unwrap_or_clone", issue = "93610")]
1238 pub fn unwrap_or_clone(this: Self) -> T {
1239 Rc::try_unwrap(this).unwrap_or_else(|rc| (*rc).clone())
1245 #[stable(feature = "rc_downcast", since = "1.29.0")]
1246 /// Attempt to downcast the `Rc<dyn Any>` to a concrete type.
1251 /// use std::any::Any;
1252 /// use std::rc::Rc;
1254 /// fn print_if_string(value: Rc<dyn Any>) {
1255 /// if let Ok(string) = value.downcast::<String>() {
1256 /// println!("String ({}): {}", string.len(), string);
1260 /// let my_string = "Hello World".to_string();
1261 /// print_if_string(Rc::new(my_string));
1262 /// print_if_string(Rc::new(0i8));
1264 pub fn downcast<T: Any>(self) -> Result<Rc<T>, Rc<dyn Any>> {
1265 if (*self).is::<T>() {
1267 let ptr = self.ptr.cast::<RcBox<T>>();
1269 Ok(Rc::from_inner(ptr))
1277 impl<T: ?Sized> Rc<T> {
1278 /// Allocates an `RcBox<T>` with sufficient space for
1279 /// a possibly-unsized inner value where the value has the layout provided.
1281 /// The function `mem_to_rcbox` is called with the data pointer
1282 /// and must return back a (potentially fat)-pointer for the `RcBox<T>`.
1283 #[cfg(not(no_global_oom_handling))]
1284 unsafe fn allocate_for_layout(
1285 value_layout: Layout,
1286 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1287 mem_to_rcbox: impl FnOnce(*mut u8) -> *mut RcBox<T>,
1288 ) -> *mut RcBox<T> {
1289 // Calculate layout using the given value layout.
1290 // Previously, layout was calculated on the expression
1291 // `&*(ptr as *const RcBox<T>)`, but this created a misaligned
1292 // reference (see #54908).
1293 let layout = Layout::new::<RcBox<()>>().extend(value_layout).unwrap().0.pad_to_align();
1295 Rc::try_allocate_for_layout(value_layout, allocate, mem_to_rcbox)
1296 .unwrap_or_else(|_| handle_alloc_error(layout))
1300 /// Allocates an `RcBox<T>` with sufficient space for
1301 /// a possibly-unsized inner value where the value has the layout provided,
1302 /// returning an error if allocation fails.
1304 /// The function `mem_to_rcbox` is called with the data pointer
1305 /// and must return back a (potentially fat)-pointer for the `RcBox<T>`.
1307 unsafe fn try_allocate_for_layout(
1308 value_layout: Layout,
1309 allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
1310 mem_to_rcbox: impl FnOnce(*mut u8) -> *mut RcBox<T>,
1311 ) -> Result<*mut RcBox<T>, AllocError> {
1312 // Calculate layout using the given value layout.
1313 // Previously, layout was calculated on the expression
1314 // `&*(ptr as *const RcBox<T>)`, but this created a misaligned
1315 // reference (see #54908).
1316 let layout = Layout::new::<RcBox<()>>().extend(value_layout).unwrap().0.pad_to_align();
1318 // Allocate for the layout.
1319 let ptr = allocate(layout)?;
1321 // Initialize the RcBox
1322 let inner = mem_to_rcbox(ptr.as_non_null_ptr().as_ptr());
1324 debug_assert_eq!(Layout::for_value(&*inner), layout);
1326 ptr::write(&mut (*inner).strong, Cell::new(1));
1327 ptr::write(&mut (*inner).weak, Cell::new(1));
1333 /// Allocates an `RcBox<T>` with sufficient space for an unsized inner value
1334 #[cfg(not(no_global_oom_handling))]
1335 unsafe fn allocate_for_ptr(ptr: *const T) -> *mut RcBox<T> {
1336 // Allocate for the `RcBox<T>` using the given value.
1338 Self::allocate_for_layout(
1339 Layout::for_value(&*ptr),
1340 |layout| Global.allocate(layout),
1341 |mem| mem.with_metadata_of(ptr as *mut RcBox<T>),
1346 #[cfg(not(no_global_oom_handling))]
1347 fn from_box(v: Box<T>) -> Rc<T> {
1349 let (box_unique, alloc) = Box::into_unique(v);
1350 let bptr = box_unique.as_ptr();
1352 let value_size = size_of_val(&*bptr);
1353 let ptr = Self::allocate_for_ptr(bptr);
1355 // Copy value as bytes
1356 ptr::copy_nonoverlapping(
1357 bptr as *const T as *const u8,
1358 &mut (*ptr).value as *mut _ as *mut u8,
1362 // Free the allocation without dropping its contents
1363 box_free(box_unique, alloc);
1371 /// Allocates an `RcBox<[T]>` with the given length.
1372 #[cfg(not(no_global_oom_handling))]
1373 unsafe fn allocate_for_slice(len: usize) -> *mut RcBox<[T]> {
1375 Self::allocate_for_layout(
1376 Layout::array::<T>(len).unwrap(),
1377 |layout| Global.allocate(layout),
1378 |mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut RcBox<[T]>,
1383 /// Copy elements from slice into newly allocated Rc<\[T\]>
1385 /// Unsafe because the caller must either take ownership or bind `T: Copy`
1386 #[cfg(not(no_global_oom_handling))]
1387 unsafe fn copy_from_slice(v: &[T]) -> Rc<[T]> {
1389 let ptr = Self::allocate_for_slice(v.len());
1390 ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).value as *mut [T] as *mut T, v.len());
1395 /// Constructs an `Rc<[T]>` from an iterator known to be of a certain size.
1397 /// Behavior is undefined should the size be wrong.
1398 #[cfg(not(no_global_oom_handling))]
1399 unsafe fn from_iter_exact(iter: impl iter::Iterator<Item = T>, len: usize) -> Rc<[T]> {
1400 // Panic guard while cloning T elements.
1401 // In the event of a panic, elements that have been written
1402 // into the new RcBox will be dropped, then the memory freed.
1410 impl<T> Drop for Guard<T> {
1411 fn drop(&mut self) {
1413 let slice = from_raw_parts_mut(self.elems, self.n_elems);
1414 ptr::drop_in_place(slice);
1416 Global.deallocate(self.mem, self.layout);
1422 let ptr = Self::allocate_for_slice(len);
1424 let mem = ptr as *mut _ as *mut u8;
1425 let layout = Layout::for_value(&*ptr);
1427 // Pointer to first element
1428 let elems = &mut (*ptr).value as *mut [T] as *mut T;
1430 let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
1432 for (i, item) in iter.enumerate() {
1433 ptr::write(elems.add(i), item);
1437 // All clear. Forget the guard so it doesn't free the new RcBox.
1445 /// Specialization trait used for `From<&[T]>`.
1446 trait RcFromSlice<T> {
1447 fn from_slice(slice: &[T]) -> Self;
1450 #[cfg(not(no_global_oom_handling))]
1451 impl<T: Clone> RcFromSlice<T> for Rc<[T]> {
1453 default fn from_slice(v: &[T]) -> Self {
1454 unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
1458 #[cfg(not(no_global_oom_handling))]
1459 impl<T: Copy> RcFromSlice<T> for Rc<[T]> {
1461 fn from_slice(v: &[T]) -> Self {
1462 unsafe { Rc::copy_from_slice(v) }
1466 #[stable(feature = "rust1", since = "1.0.0")]
1467 impl<T: ?Sized> Deref for Rc<T> {
1471 fn deref(&self) -> &T {
1476 #[unstable(feature = "receiver_trait", issue = "none")]
1477 impl<T: ?Sized> Receiver for Rc<T> {}
1479 #[stable(feature = "rust1", since = "1.0.0")]
1480 unsafe impl<#[may_dangle] T: ?Sized> Drop for Rc<T> {
1483 /// This will decrement the strong reference count. If the strong reference
1484 /// count reaches zero then the only other references (if any) are
1485 /// [`Weak`], so we `drop` the inner value.
1490 /// use std::rc::Rc;
1494 /// impl Drop for Foo {
1495 /// fn drop(&mut self) {
1496 /// println!("dropped!");
1500 /// let foo = Rc::new(Foo);
1501 /// let foo2 = Rc::clone(&foo);
1503 /// drop(foo); // Doesn't print anything
1504 /// drop(foo2); // Prints "dropped!"
1506 fn drop(&mut self) {
1508 self.inner().dec_strong();
1509 if self.inner().strong() == 0 {
1510 // destroy the contained object
1511 ptr::drop_in_place(Self::get_mut_unchecked(self));
1513 // remove the implicit "strong weak" pointer now that we've
1514 // destroyed the contents.
1515 self.inner().dec_weak();
1517 if self.inner().weak() == 0 {
1518 Global.deallocate(self.ptr.cast(), Layout::for_value(self.ptr.as_ref()));
1525 #[stable(feature = "rust1", since = "1.0.0")]
1526 impl<T: ?Sized> Clone for Rc<T> {
1527 /// Makes a clone of the `Rc` pointer.
1529 /// This creates another pointer to the same allocation, increasing the
1530 /// strong reference count.
1535 /// use std::rc::Rc;
1537 /// let five = Rc::new(5);
1539 /// let _ = Rc::clone(&five);
1542 fn clone(&self) -> Rc<T> {
1544 self.inner().inc_strong();
1545 Self::from_inner(self.ptr)
1550 #[cfg(not(no_global_oom_handling))]
1551 #[stable(feature = "rust1", since = "1.0.0")]
1552 impl<T: Default> Default for Rc<T> {
1553 /// Creates a new `Rc<T>`, with the `Default` value for `T`.
1558 /// use std::rc::Rc;
1560 /// let x: Rc<i32> = Default::default();
1561 /// assert_eq!(*x, 0);
1564 fn default() -> Rc<T> {
1565 Rc::new(Default::default())
1569 #[stable(feature = "rust1", since = "1.0.0")]
1570 trait RcEqIdent<T: ?Sized + PartialEq> {
1571 fn eq(&self, other: &Rc<T>) -> bool;
1572 fn ne(&self, other: &Rc<T>) -> bool;
1575 #[stable(feature = "rust1", since = "1.0.0")]
1576 impl<T: ?Sized + PartialEq> RcEqIdent<T> for Rc<T> {
1578 default fn eq(&self, other: &Rc<T>) -> bool {
1583 default fn ne(&self, other: &Rc<T>) -> bool {
1588 // Hack to allow specializing on `Eq` even though `Eq` has a method.
1589 #[rustc_unsafe_specialization_marker]
1590 pub(crate) trait MarkerEq: PartialEq<Self> {}
1592 impl<T: Eq> MarkerEq for T {}
1594 /// We're doing this specialization here, and not as a more general optimization on `&T`, because it
1595 /// would otherwise add a cost to all equality checks on refs. We assume that `Rc`s are used to
1596 /// store large values, that are slow to clone, but also heavy to check for equality, causing this
1597 /// cost to pay off more easily. It's also more likely to have two `Rc` clones, that point to
1598 /// the same value, than two `&T`s.
1600 /// We can only do this when `T: Eq` as a `PartialEq` might be deliberately irreflexive.
1601 #[stable(feature = "rust1", since = "1.0.0")]
1602 impl<T: ?Sized + MarkerEq> RcEqIdent<T> for Rc<T> {
1604 fn eq(&self, other: &Rc<T>) -> bool {
1605 Rc::ptr_eq(self, other) || **self == **other
1609 fn ne(&self, other: &Rc<T>) -> bool {
1610 !Rc::ptr_eq(self, other) && **self != **other
1614 #[stable(feature = "rust1", since = "1.0.0")]
1615 impl<T: ?Sized + PartialEq> PartialEq for Rc<T> {
1616 /// Equality for two `Rc`s.
1618 /// Two `Rc`s are equal if their inner values are equal, even if they are
1619 /// stored in different allocation.
1621 /// If `T` also implements `Eq` (implying reflexivity of equality),
1622 /// two `Rc`s that point to the same allocation are
1628 /// use std::rc::Rc;
1630 /// let five = Rc::new(5);
1632 /// assert!(five == Rc::new(5));
1635 fn eq(&self, other: &Rc<T>) -> bool {
1636 RcEqIdent::eq(self, other)
1639 /// Inequality for two `Rc`s.
1641 /// Two `Rc`s are unequal if their inner values are unequal.
1643 /// If `T` also implements `Eq` (implying reflexivity of equality),
1644 /// two `Rc`s that point to the same allocation are
1650 /// use std::rc::Rc;
1652 /// let five = Rc::new(5);
1654 /// assert!(five != Rc::new(6));
1657 fn ne(&self, other: &Rc<T>) -> bool {
1658 RcEqIdent::ne(self, other)
1662 #[stable(feature = "rust1", since = "1.0.0")]
1663 impl<T: ?Sized + Eq> Eq for Rc<T> {}
1665 #[stable(feature = "rust1", since = "1.0.0")]
1666 impl<T: ?Sized + PartialOrd> PartialOrd for Rc<T> {
1667 /// Partial comparison for two `Rc`s.
1669 /// The two are compared by calling `partial_cmp()` on their inner values.
1674 /// use std::rc::Rc;
1675 /// use std::cmp::Ordering;
1677 /// let five = Rc::new(5);
1679 /// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Rc::new(6)));
1682 fn partial_cmp(&self, other: &Rc<T>) -> Option<Ordering> {
1683 (**self).partial_cmp(&**other)
1686 /// Less-than comparison for two `Rc`s.
1688 /// The two are compared by calling `<` on their inner values.
1693 /// use std::rc::Rc;
1695 /// let five = Rc::new(5);
1697 /// assert!(five < Rc::new(6));
1700 fn lt(&self, other: &Rc<T>) -> bool {
1704 /// 'Less than or equal to' comparison for two `Rc`s.
1706 /// The two are compared by calling `<=` on their inner values.
1711 /// use std::rc::Rc;
1713 /// let five = Rc::new(5);
1715 /// assert!(five <= Rc::new(5));
1718 fn le(&self, other: &Rc<T>) -> bool {
1722 /// Greater-than comparison for two `Rc`s.
1724 /// The two are compared by calling `>` on their inner values.
1729 /// use std::rc::Rc;
1731 /// let five = Rc::new(5);
1733 /// assert!(five > Rc::new(4));
1736 fn gt(&self, other: &Rc<T>) -> bool {
1740 /// 'Greater than or equal to' comparison for two `Rc`s.
1742 /// The two are compared by calling `>=` on their inner values.
1747 /// use std::rc::Rc;
1749 /// let five = Rc::new(5);
1751 /// assert!(five >= Rc::new(5));
1754 fn ge(&self, other: &Rc<T>) -> bool {
1759 #[stable(feature = "rust1", since = "1.0.0")]
1760 impl<T: ?Sized + Ord> Ord for Rc<T> {
1761 /// Comparison for two `Rc`s.
1763 /// The two are compared by calling `cmp()` on their inner values.
1768 /// use std::rc::Rc;
1769 /// use std::cmp::Ordering;
1771 /// let five = Rc::new(5);
1773 /// assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));
1776 fn cmp(&self, other: &Rc<T>) -> Ordering {
1777 (**self).cmp(&**other)
1781 #[stable(feature = "rust1", since = "1.0.0")]
1782 impl<T: ?Sized + Hash> Hash for Rc<T> {
1783 fn hash<H: Hasher>(&self, state: &mut H) {
1784 (**self).hash(state);
1788 #[stable(feature = "rust1", since = "1.0.0")]
1789 impl<T: ?Sized + fmt::Display> fmt::Display for Rc<T> {
1790 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1791 fmt::Display::fmt(&**self, f)
1795 #[stable(feature = "rust1", since = "1.0.0")]
1796 impl<T: ?Sized + fmt::Debug> fmt::Debug for Rc<T> {
1797 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1798 fmt::Debug::fmt(&**self, f)
1802 #[stable(feature = "rust1", since = "1.0.0")]
1803 impl<T: ?Sized> fmt::Pointer for Rc<T> {
1804 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1805 fmt::Pointer::fmt(&(&**self as *const T), f)
1809 #[cfg(not(no_global_oom_handling))]
1810 #[stable(feature = "from_for_ptrs", since = "1.6.0")]
1811 impl<T> From<T> for Rc<T> {
1812 /// Converts a generic type `T` into an `Rc<T>`
1814 /// The conversion allocates on the heap and moves `t`
1815 /// from the stack into it.
1819 /// # use std::rc::Rc;
1821 /// let rc = Rc::new(5);
1823 /// assert_eq!(Rc::from(x), rc);
1825 fn from(t: T) -> Self {
1830 #[cfg(not(no_global_oom_handling))]
1831 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1832 impl<T: Clone> From<&[T]> for Rc<[T]> {
1833 /// Allocate a reference-counted slice and fill it by cloning `v`'s items.
1838 /// # use std::rc::Rc;
1839 /// let original: &[i32] = &[1, 2, 3];
1840 /// let shared: Rc<[i32]> = Rc::from(original);
1841 /// assert_eq!(&[1, 2, 3], &shared[..]);
1844 fn from(v: &[T]) -> Rc<[T]> {
1845 <Self as RcFromSlice<T>>::from_slice(v)
1849 #[cfg(not(no_global_oom_handling))]
1850 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1851 impl From<&str> for Rc<str> {
1852 /// Allocate a reference-counted string slice and copy `v` into it.
1857 /// # use std::rc::Rc;
1858 /// let shared: Rc<str> = Rc::from("statue");
1859 /// assert_eq!("statue", &shared[..]);
1862 fn from(v: &str) -> Rc<str> {
1863 let rc = Rc::<[u8]>::from(v.as_bytes());
1864 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const str) }
1868 #[cfg(not(no_global_oom_handling))]
1869 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1870 impl From<String> for Rc<str> {
1871 /// Allocate a reference-counted string slice and copy `v` into it.
1876 /// # use std::rc::Rc;
1877 /// let original: String = "statue".to_owned();
1878 /// let shared: Rc<str> = Rc::from(original);
1879 /// assert_eq!("statue", &shared[..]);
1882 fn from(v: String) -> Rc<str> {
1887 #[cfg(not(no_global_oom_handling))]
1888 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1889 impl<T: ?Sized> From<Box<T>> for Rc<T> {
1890 /// Move a boxed object to a new, reference counted, allocation.
1895 /// # use std::rc::Rc;
1896 /// let original: Box<i32> = Box::new(1);
1897 /// let shared: Rc<i32> = Rc::from(original);
1898 /// assert_eq!(1, *shared);
1901 fn from(v: Box<T>) -> Rc<T> {
1906 #[cfg(not(no_global_oom_handling))]
1907 #[stable(feature = "shared_from_slice", since = "1.21.0")]
1908 impl<T> From<Vec<T>> for Rc<[T]> {
1909 /// Allocate a reference-counted slice and move `v`'s items into it.
1914 /// # use std::rc::Rc;
1915 /// let original: Box<Vec<i32>> = Box::new(vec![1, 2, 3]);
1916 /// let shared: Rc<Vec<i32>> = Rc::from(original);
1917 /// assert_eq!(vec![1, 2, 3], *shared);
1920 fn from(mut v: Vec<T>) -> Rc<[T]> {
1922 let rc = Rc::copy_from_slice(&v);
1924 // Allow the Vec to free its memory, but not destroy its contents
1932 #[stable(feature = "shared_from_cow", since = "1.45.0")]
1933 impl<'a, B> From<Cow<'a, B>> for Rc<B>
1935 B: ToOwned + ?Sized,
1936 Rc<B>: From<&'a B> + From<B::Owned>,
1938 /// Create a reference-counted pointer from
1939 /// a clone-on-write pointer by copying its content.
1944 /// # use std::rc::Rc;
1945 /// # use std::borrow::Cow;
1946 /// let cow: Cow<str> = Cow::Borrowed("eggplant");
1947 /// let shared: Rc<str> = Rc::from(cow);
1948 /// assert_eq!("eggplant", &shared[..]);
1951 fn from(cow: Cow<'a, B>) -> Rc<B> {
1953 Cow::Borrowed(s) => Rc::from(s),
1954 Cow::Owned(s) => Rc::from(s),
1959 #[stable(feature = "shared_from_str", since = "1.62.0")]
1960 impl From<Rc<str>> for Rc<[u8]> {
1961 /// Converts a reference-counted string slice into a byte slice.
1966 /// # use std::rc::Rc;
1967 /// let string: Rc<str> = Rc::from("eggplant");
1968 /// let bytes: Rc<[u8]> = Rc::from(string);
1969 /// assert_eq!("eggplant".as_bytes(), bytes.as_ref());
1972 fn from(rc: Rc<str>) -> Self {
1973 // SAFETY: `str` has the same layout as `[u8]`.
1974 unsafe { Rc::from_raw(Rc::into_raw(rc) as *const [u8]) }
1978 #[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
1979 impl<T, const N: usize> TryFrom<Rc<[T]>> for Rc<[T; N]> {
1980 type Error = Rc<[T]>;
1982 fn try_from(boxed_slice: Rc<[T]>) -> Result<Self, Self::Error> {
1983 if boxed_slice.len() == N {
1984 Ok(unsafe { Rc::from_raw(Rc::into_raw(boxed_slice) as *mut [T; N]) })
1991 #[cfg(not(no_global_oom_handling))]
1992 #[stable(feature = "shared_from_iter", since = "1.37.0")]
1993 impl<T> iter::FromIterator<T> for Rc<[T]> {
1994 /// Takes each element in the `Iterator` and collects it into an `Rc<[T]>`.
1996 /// # Performance characteristics
1998 /// ## The general case
2000 /// In the general case, collecting into `Rc<[T]>` is done by first
2001 /// collecting into a `Vec<T>`. That is, when writing the following:
2004 /// # use std::rc::Rc;
2005 /// let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
2006 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2009 /// this behaves as if we wrote:
2012 /// # use std::rc::Rc;
2013 /// let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
2014 /// .collect::<Vec<_>>() // The first set of allocations happens here.
2015 /// .into(); // A second allocation for `Rc<[T]>` happens here.
2016 /// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
2019 /// This will allocate as many times as needed for constructing the `Vec<T>`
2020 /// and then it will allocate once for turning the `Vec<T>` into the `Rc<[T]>`.
2022 /// ## Iterators of known length
2024 /// When your `Iterator` implements `TrustedLen` and is of an exact size,
2025 /// a single allocation will be made for the `Rc<[T]>`. For example:
2028 /// # use std::rc::Rc;
2029 /// let evens: Rc<[u8]> = (0..10).collect(); // Just a single allocation happens here.
2030 /// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
2032 fn from_iter<I: iter::IntoIterator<Item = T>>(iter: I) -> Self {
2033 ToRcSlice::to_rc_slice(iter.into_iter())
2037 /// Specialization trait used for collecting into `Rc<[T]>`.
2038 #[cfg(not(no_global_oom_handling))]
2039 trait ToRcSlice<T>: Iterator<Item = T> + Sized {
2040 fn to_rc_slice(self) -> Rc<[T]>;
2043 #[cfg(not(no_global_oom_handling))]
2044 impl<T, I: Iterator<Item = T>> ToRcSlice<T> for I {
2045 default fn to_rc_slice(self) -> Rc<[T]> {
2046 self.collect::<Vec<T>>().into()
2050 #[cfg(not(no_global_oom_handling))]
2051 impl<T, I: iter::TrustedLen<Item = T>> ToRcSlice<T> for I {
2052 fn to_rc_slice(self) -> Rc<[T]> {
2053 // This is the case for a `TrustedLen` iterator.
2054 let (low, high) = self.size_hint();
2055 if let Some(high) = high {
2059 "TrustedLen iterator's size hint is not exact: {:?}",
2064 // SAFETY: We need to ensure that the iterator has an exact length and we have.
2065 Rc::from_iter_exact(self, low)
2068 // TrustedLen contract guarantees that `upper_bound == `None` implies an iterator
2069 // length exceeding `usize::MAX`.
2070 // The default implementation would collect into a vec which would panic.
2071 // Thus we panic here immediately without invoking `Vec` code.
2072 panic!("capacity overflow");
2077 /// `Weak` is a version of [`Rc`] that holds a non-owning reference to the
2078 /// managed allocation. The allocation is accessed by calling [`upgrade`] on the `Weak`
2079 /// pointer, which returns an <code>[Option]<[Rc]\<T>></code>.
2081 /// Since a `Weak` reference does not count towards ownership, it will not
2082 /// prevent the value stored in the allocation from being dropped, and `Weak` itself makes no
2083 /// guarantees about the value still being present. Thus it may return [`None`]
2084 /// when [`upgrade`]d. Note however that a `Weak` reference *does* prevent the allocation
2085 /// itself (the backing store) from being deallocated.
2087 /// A `Weak` pointer is useful for keeping a temporary reference to the allocation
2088 /// managed by [`Rc`] without preventing its inner value from being dropped. It is also used to
2089 /// prevent circular references between [`Rc`] pointers, since mutual owning references
2090 /// would never allow either [`Rc`] to be dropped. For example, a tree could
2091 /// have strong [`Rc`] pointers from parent nodes to children, and `Weak`
2092 /// pointers from children back to their parents.
2094 /// The typical way to obtain a `Weak` pointer is to call [`Rc::downgrade`].
2096 /// [`upgrade`]: Weak::upgrade
2097 #[stable(feature = "rc_weak", since = "1.4.0")]
2098 pub struct Weak<T: ?Sized> {
2099 // This is a `NonNull` to allow optimizing the size of this type in enums,
2100 // but it is not necessarily a valid pointer.
2101 // `Weak::new` sets this to `usize::MAX` so that it doesn’t need
2102 // to allocate space on the heap. That's not a value a real pointer
2103 // will ever have because RcBox has alignment at least 2.
2104 // This is only possible when `T: Sized`; unsized `T` never dangle.
2105 ptr: NonNull<RcBox<T>>,
2108 #[stable(feature = "rc_weak", since = "1.4.0")]
2109 impl<T: ?Sized> !marker::Send for Weak<T> {}
2110 #[stable(feature = "rc_weak", since = "1.4.0")]
2111 impl<T: ?Sized> !marker::Sync for Weak<T> {}
2113 #[unstable(feature = "coerce_unsized", issue = "27732")]
2114 impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
2116 #[unstable(feature = "dispatch_from_dyn", issue = "none")]
2117 impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
2120 /// Constructs a new `Weak<T>`, without allocating any memory.
2121 /// Calling [`upgrade`] on the return value always gives [`None`].
2123 /// [`upgrade`]: Weak::upgrade
2128 /// use std::rc::Weak;
2130 /// let empty: Weak<i64> = Weak::new();
2131 /// assert!(empty.upgrade().is_none());
2133 #[stable(feature = "downgraded_weak", since = "1.10.0")]
2134 #[rustc_const_unstable(feature = "const_weak_new", issue = "95091", reason = "recently added")]
2136 pub const fn new() -> Weak<T> {
2137 Weak { ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<RcBox<T>>(usize::MAX)) } }
2141 pub(crate) fn is_dangling<T: ?Sized>(ptr: *mut T) -> bool {
2142 (ptr as *mut ()).addr() == usize::MAX
2145 /// Helper type to allow accessing the reference counts without
2146 /// making any assertions about the data field.
2147 struct WeakInner<'a> {
2148 weak: &'a Cell<usize>,
2149 strong: &'a Cell<usize>,
2152 impl<T: ?Sized> Weak<T> {
2153 /// Returns a raw pointer to the object `T` pointed to by this `Weak<T>`.
2155 /// The pointer is valid only if there are some strong references. The pointer may be dangling,
2156 /// unaligned or even [`null`] otherwise.
2161 /// use std::rc::Rc;
2164 /// let strong = Rc::new("hello".to_owned());
2165 /// let weak = Rc::downgrade(&strong);
2166 /// // Both point to the same object
2167 /// assert!(ptr::eq(&*strong, weak.as_ptr()));
2168 /// // The strong here keeps it alive, so we can still access the object.
2169 /// assert_eq!("hello", unsafe { &*weak.as_ptr() });
2172 /// // But not any more. We can do weak.as_ptr(), but accessing the pointer would lead to
2173 /// // undefined behaviour.
2174 /// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
2177 /// [`null`]: ptr::null
2179 #[stable(feature = "rc_as_ptr", since = "1.45.0")]
2180 pub fn as_ptr(&self) -> *const T {
2181 let ptr: *mut RcBox<T> = NonNull::as_ptr(self.ptr);
2183 if is_dangling(ptr) {
2184 // If the pointer is dangling, we return the sentinel directly. This cannot be
2185 // a valid payload address, as the payload is at least as aligned as RcBox (usize).
2188 // SAFETY: if is_dangling returns false, then the pointer is dereferenceable.
2189 // The payload may be dropped at this point, and we have to maintain provenance,
2190 // so use raw pointer manipulation.
2191 unsafe { ptr::addr_of_mut!((*ptr).value) }
2195 /// Consumes the `Weak<T>` and turns it into a raw pointer.
2197 /// This converts the weak pointer into a raw pointer, while still preserving the ownership of
2198 /// one weak reference (the weak count is not modified by this operation). It can be turned
2199 /// back into the `Weak<T>` with [`from_raw`].
2201 /// The same restrictions of accessing the target of the pointer as with
2202 /// [`as_ptr`] apply.
2207 /// use std::rc::{Rc, Weak};
2209 /// let strong = Rc::new("hello".to_owned());
2210 /// let weak = Rc::downgrade(&strong);
2211 /// let raw = weak.into_raw();
2213 /// assert_eq!(1, Rc::weak_count(&strong));
2214 /// assert_eq!("hello", unsafe { &*raw });
2216 /// drop(unsafe { Weak::from_raw(raw) });
2217 /// assert_eq!(0, Rc::weak_count(&strong));
2220 /// [`from_raw`]: Weak::from_raw
2221 /// [`as_ptr`]: Weak::as_ptr
2222 #[must_use = "`self` will be dropped if the result is not used"]
2223 #[stable(feature = "weak_into_raw", since = "1.45.0")]
2224 pub fn into_raw(self) -> *const T {
2225 let result = self.as_ptr();
2230 /// Converts a raw pointer previously created by [`into_raw`] back into `Weak<T>`.
2232 /// This can be used to safely get a strong reference (by calling [`upgrade`]
2233 /// later) or to deallocate the weak count by dropping the `Weak<T>`.
2235 /// It takes ownership of one weak reference (with the exception of pointers created by [`new`],
2236 /// as these don't own anything; the method still works on them).
2240 /// The pointer must have originated from the [`into_raw`] and must still own its potential
2243 /// It is allowed for the strong count to be 0 at the time of calling this. Nevertheless, this
2244 /// takes ownership of one weak reference currently represented as a raw pointer (the weak
2245 /// count is not modified by this operation) and therefore it must be paired with a previous
2246 /// call to [`into_raw`].
2251 /// use std::rc::{Rc, Weak};
2253 /// let strong = Rc::new("hello".to_owned());
2255 /// let raw_1 = Rc::downgrade(&strong).into_raw();
2256 /// let raw_2 = Rc::downgrade(&strong).into_raw();
2258 /// assert_eq!(2, Rc::weak_count(&strong));
2260 /// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
2261 /// assert_eq!(1, Rc::weak_count(&strong));
2265 /// // Decrement the last weak count.
2266 /// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
2269 /// [`into_raw`]: Weak::into_raw
2270 /// [`upgrade`]: Weak::upgrade
2271 /// [`new`]: Weak::new
2272 #[stable(feature = "weak_into_raw", since = "1.45.0")]
2273 pub unsafe fn from_raw(ptr: *const T) -> Self {
2274 // See Weak::as_ptr for context on how the input pointer is derived.
2276 let ptr = if is_dangling(ptr as *mut T) {
2277 // This is a dangling Weak.
2278 ptr as *mut RcBox<T>
2280 // Otherwise, we're guaranteed the pointer came from a nondangling Weak.
2281 // SAFETY: data_offset is safe to call, as ptr references a real (potentially dropped) T.
2282 let offset = unsafe { data_offset(ptr) };
2283 // Thus, we reverse the offset to get the whole RcBox.
2284 // SAFETY: the pointer originated from a Weak, so this offset is safe.
2285 unsafe { (ptr as *mut u8).offset(-offset).with_metadata_of(ptr as *mut RcBox<T>) }
2288 // SAFETY: we now have recovered the original Weak pointer, so can create the Weak.
2289 Weak { ptr: unsafe { NonNull::new_unchecked(ptr) } }
2292 /// Attempts to upgrade the `Weak` pointer to an [`Rc`], delaying
2293 /// dropping of the inner value if successful.
2295 /// Returns [`None`] if the inner value has since been dropped.
2300 /// use std::rc::Rc;
2302 /// let five = Rc::new(5);
2304 /// let weak_five = Rc::downgrade(&five);
2306 /// let strong_five: Option<Rc<_>> = weak_five.upgrade();
2307 /// assert!(strong_five.is_some());
2309 /// // Destroy all strong pointers.
2310 /// drop(strong_five);
2313 /// assert!(weak_five.upgrade().is_none());
2315 #[must_use = "this returns a new `Rc`, \
2316 without modifying the original weak pointer"]
2317 #[stable(feature = "rc_weak", since = "1.4.0")]
2318 pub fn upgrade(&self) -> Option<Rc<T>> {
2319 let inner = self.inner()?;
2321 if inner.strong() == 0 {
2326 Some(Rc::from_inner(self.ptr))
2331 /// Gets the number of strong (`Rc`) pointers pointing to this allocation.
2333 /// If `self` was created using [`Weak::new`], this will return 0.
2335 #[stable(feature = "weak_counts", since = "1.41.0")]
2336 pub fn strong_count(&self) -> usize {
2337 if let Some(inner) = self.inner() { inner.strong() } else { 0 }
2340 /// Gets the number of `Weak` pointers pointing to this allocation.
2342 /// If no strong pointers remain, this will return zero.
2344 #[stable(feature = "weak_counts", since = "1.41.0")]
2345 pub fn weak_count(&self) -> usize {
2348 if inner.strong() > 0 {
2349 inner.weak() - 1 // subtract the implicit weak ptr
2357 /// Returns `None` when the pointer is dangling and there is no allocated `RcBox`,
2358 /// (i.e., when this `Weak` was created by `Weak::new`).
2360 fn inner(&self) -> Option<WeakInner<'_>> {
2361 if is_dangling(self.ptr.as_ptr()) {
2364 // We are careful to *not* create a reference covering the "data" field, as
2365 // the field may be mutated concurrently (for example, if the last `Rc`
2366 // is dropped, the data field will be dropped in-place).
2368 let ptr = self.ptr.as_ptr();
2369 WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
2374 /// Returns `true` if the two `Weak`s point to the same allocation (similar to
2375 /// [`ptr::eq`]), or if both don't point to any allocation
2376 /// (because they were created with `Weak::new()`).
2380 /// Since this compares pointers it means that `Weak::new()` will equal each
2381 /// other, even though they don't point to any allocation.
2386 /// use std::rc::Rc;
2388 /// let first_rc = Rc::new(5);
2389 /// let first = Rc::downgrade(&first_rc);
2390 /// let second = Rc::downgrade(&first_rc);
2392 /// assert!(first.ptr_eq(&second));
2394 /// let third_rc = Rc::new(5);
2395 /// let third = Rc::downgrade(&third_rc);
2397 /// assert!(!first.ptr_eq(&third));
2400 /// Comparing `Weak::new`.
2403 /// use std::rc::{Rc, Weak};
2405 /// let first = Weak::new();
2406 /// let second = Weak::new();
2407 /// assert!(first.ptr_eq(&second));
2409 /// let third_rc = Rc::new(());
2410 /// let third = Rc::downgrade(&third_rc);
2411 /// assert!(!first.ptr_eq(&third));
2415 #[stable(feature = "weak_ptr_eq", since = "1.39.0")]
2416 pub fn ptr_eq(&self, other: &Self) -> bool {
2417 self.ptr.as_ptr() == other.ptr.as_ptr()
2421 #[stable(feature = "rc_weak", since = "1.4.0")]
2422 unsafe impl<#[may_dangle] T: ?Sized> Drop for Weak<T> {
2423 /// Drops the `Weak` pointer.
2428 /// use std::rc::{Rc, Weak};
2432 /// impl Drop for Foo {
2433 /// fn drop(&mut self) {
2434 /// println!("dropped!");
2438 /// let foo = Rc::new(Foo);
2439 /// let weak_foo = Rc::downgrade(&foo);
2440 /// let other_weak_foo = Weak::clone(&weak_foo);
2442 /// drop(weak_foo); // Doesn't print anything
2443 /// drop(foo); // Prints "dropped!"
2445 /// assert!(other_weak_foo.upgrade().is_none());
2447 fn drop(&mut self) {
2448 let inner = if let Some(inner) = self.inner() { inner } else { return };
2451 // the weak count starts at 1, and will only go to zero if all
2452 // the strong pointers have disappeared.
2453 if inner.weak() == 0 {
2455 Global.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr()));
2461 #[stable(feature = "rc_weak", since = "1.4.0")]
2462 impl<T: ?Sized> Clone for Weak<T> {
2463 /// Makes a clone of the `Weak` pointer that points to the same allocation.
2468 /// use std::rc::{Rc, Weak};
2470 /// let weak_five = Rc::downgrade(&Rc::new(5));
2472 /// let _ = Weak::clone(&weak_five);
2475 fn clone(&self) -> Weak<T> {
2476 if let Some(inner) = self.inner() {
2479 Weak { ptr: self.ptr }
2483 #[stable(feature = "rc_weak", since = "1.4.0")]
2484 impl<T: ?Sized + fmt::Debug> fmt::Debug for Weak<T> {
2485 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2490 #[stable(feature = "downgraded_weak", since = "1.10.0")]
2491 impl<T> Default for Weak<T> {
2492 /// Constructs a new `Weak<T>`, without allocating any memory.
2493 /// Calling [`upgrade`] on the return value always gives [`None`].
2495 /// [`upgrade`]: Weak::upgrade
2500 /// use std::rc::Weak;
2502 /// let empty: Weak<i64> = Default::default();
2503 /// assert!(empty.upgrade().is_none());
2505 fn default() -> Weak<T> {
2510 // NOTE: We checked_add here to deal with mem::forget safely. In particular
2511 // if you mem::forget Rcs (or Weaks), the ref-count can overflow, and then
2512 // you can free the allocation while outstanding Rcs (or Weaks) exist.
2513 // We abort because this is such a degenerate scenario that we don't care about
2514 // what happens -- no real program should ever experience this.
2516 // This should have negligible overhead since you don't actually need to
2517 // clone these much in Rust thanks to ownership and move-semantics.
2521 fn weak_ref(&self) -> &Cell<usize>;
2522 fn strong_ref(&self) -> &Cell<usize>;
2525 fn strong(&self) -> usize {
2526 self.strong_ref().get()
2530 fn inc_strong(&self) {
2531 let strong = self.strong();
2533 // We insert an `assume` here to hint LLVM at an otherwise
2534 // missed optimization.
2535 // SAFETY: The reference count will never be zero when this is
2538 core::intrinsics::assume(strong != 0);
2541 let strong = strong.wrapping_add(1);
2542 self.strong_ref().set(strong);
2544 // We want to abort on overflow instead of dropping the value.
2545 // Checking for overflow after the store instead of before
2546 // allows for slightly better code generation.
2547 if core::intrinsics::unlikely(strong == 0) {
2553 fn dec_strong(&self) {
2554 self.strong_ref().set(self.strong() - 1);
2558 fn weak(&self) -> usize {
2559 self.weak_ref().get()
2563 fn inc_weak(&self) {
2564 let weak = self.weak();
2566 // We insert an `assume` here to hint LLVM at an otherwise
2567 // missed optimization.
2568 // SAFETY: The reference count will never be zero when this is
2571 core::intrinsics::assume(weak != 0);
2574 let weak = weak.wrapping_add(1);
2575 self.weak_ref().set(weak);
2577 // We want to abort on overflow instead of dropping the value.
2578 // Checking for overflow after the store instead of before
2579 // allows for slightly better code generation.
2580 if core::intrinsics::unlikely(weak == 0) {
2586 fn dec_weak(&self) {
2587 self.weak_ref().set(self.weak() - 1);
2591 impl<T: ?Sized> RcInnerPtr for RcBox<T> {
2593 fn weak_ref(&self) -> &Cell<usize> {
2598 fn strong_ref(&self) -> &Cell<usize> {
2603 impl<'a> RcInnerPtr for WeakInner<'a> {
2605 fn weak_ref(&self) -> &Cell<usize> {
2610 fn strong_ref(&self) -> &Cell<usize> {
2615 #[stable(feature = "rust1", since = "1.0.0")]
2616 impl<T: ?Sized> borrow::Borrow<T> for Rc<T> {
2617 fn borrow(&self) -> &T {
2622 #[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
2623 impl<T: ?Sized> AsRef<T> for Rc<T> {
2624 fn as_ref(&self) -> &T {
2629 #[stable(feature = "pin", since = "1.33.0")]
2630 impl<T: ?Sized> Unpin for Rc<T> {}
2632 /// Get the offset within an `RcBox` for the payload behind a pointer.
2636 /// The pointer must point to (and have valid metadata for) a previously
2637 /// valid instance of T, but the T is allowed to be dropped.
2638 unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> isize {
2639 // Align the unsized value to the end of the RcBox.
2640 // Because RcBox is repr(C), it will always be the last field in memory.
2641 // SAFETY: since the only unsized types possible are slices, trait objects,
2642 // and extern types, the input safety requirement is currently enough to
2643 // satisfy the requirements of align_of_val_raw; this is an implementation
2644 // detail of the language that must not be relied upon outside of std.
2645 unsafe { data_offset_align(align_of_val_raw(ptr)) }
2649 fn data_offset_align(align: usize) -> isize {
2650 let layout = Layout::new::<RcBox<()>>();
2651 (layout.size() + layout.padding_needed_for(align)) as isize