std::rc - Rust
Description: API documentation for the Rust `rc` mod in crate `std`.
Keywords: rust, rustlang, rust-lang, rc

# Module std::rc 1.0.0 [−] [src]

Single-threaded reference-counting pointers.

The type `Rc<T>` provides shared ownership of a value of type `T`, allocated in the heap. Invoking `clone()` on `Rc` produces a new pointer to the same value in the heap. When the last `Rc` pointer to a given value is destroyed, the pointed-to value is also destroyed.

Shared references in Rust disallow mutation by default, and `Rc` is no exception. If you need to mutate through an `Rc`, use `Cell` or `RefCell`.

`Rc` uses non-atomic reference counting. This means that overhead is very low, but an `Rc` cannot be sent between threads, and consequently `Rc` does not implement `Send`. As a result, the Rust compiler will check at compile time that you are not sending `Rc`s between threads. If you need multi-threaded, atomic reference counting, use `sync::Arc`.

The `downgrade()` method can be used to create a non-owning `Weak` pointer. A `Weak` pointer can be `upgrade`d to an `Rc`, but this will return `None` if the value has already been dropped.

A cycle between `Rc` pointers will never be deallocated. For this reason, `Weak` is used to break cycles. For example, a tree could have strong `Rc` pointers from parent nodes to children, and `Weak` pointers from children back to their parents.

`Rc<T>` automatically dereferences to `T` (via the `Deref` trait), so you can call `T`'s methods on a value of type `Rc<T>`. To avoid name clashes with `T`'s methods, the methods of `Rc<T>` itself are associated functions, called using function-like syntax:

    use std::rc::Rc;
    let my_rc = Rc::new(());

    Rc::downgrade(&my_rc);Run

`Weak<T>` does not auto-dereference to `T`, because the value may have already been destroyed.

# Examples

Consider a scenario where a set of `Gadget`s are owned by a given `Owner`. We want to have our `Gadget`s point to their `Owner`. We can't do this with unique ownership, because more than one gadget may belong to the same `Owner`. `Rc` allows us to share an `Owner` between multiple `Gadget`s, and have the `Owner` remain allocated as long as any `Gadget` points at it.

    use std::rc::Rc;

    struct Owner {
        name: String,
        // ...other fields
    }

    struct Gadget {
        id: i32,
        owner: Rc<Owner>,
        // ...other fields
    }

    fn main() {
        // Create a reference-counted `Owner`.
        let gadget_owner: Rc<Owner> = Rc::new(
            Owner {
                name: "Gadget Man".to_string(),
            }
        );

        // Create `Gadget`s belonging to `gadget_owner`. Cloning the `Rc<Owner>`
        // value gives us a new pointer to the same `Owner` value, incrementing
        // the reference count in the process.
        let gadget1 = Gadget {
            id: 1,
            owner: gadget_owner.clone(),
        };
        let gadget2 = Gadget {
            id: 2,
            owner: gadget_owner.clone(),
        };

        // Dispose of our local variable `gadget_owner`.
        drop(gadget_owner);

        // Despite dropping `gadget_owner`, we're still able to print out the name
        // of the `Owner` of the `Gadget`s. This is because we've only dropped a
        // single `Rc<Owner>`, not the `Owner` it points to. As long as there are
        // other `Rc<Owner>` values pointing at the same `Owner`, it will remain
        // allocated. The field projection `gadget1.owner.name` works because
        // `Rc<Owner>` automatically dereferences to `Owner`.
        println!("Gadget {} owned by {}", gadget1.id, gadget1.owner.name);
        println!("Gadget {} owned by {}", gadget2.id, gadget2.owner.name);

        // At the end of the function, `gadget1` and `gadget2` are destroyed, and
        // with them the last counted references to our `Owner`. Gadget Man now
        // gets destroyed as well.
    }Run

If our requirements change, and we also need to be able to traverse from `Owner` to `Gadget`, we will run into problems. An `Rc` pointer from `Owner` to `Gadget` introduces a cycle between the values. This means that their reference counts can never reach 0, and the values will remain allocated forever: a memory leak. In order to get around this, we can use `Weak` pointers.

Rust actually makes it somewhat difficult to produce this loop in the first place. In order to end up with two values that point at each other, one of them needs to be mutable. This is difficult because `Rc` enforces memory safety by only giving out shared references to the value it wraps, and these don't allow direct mutation. We need to wrap the part of the value we wish to mutate in a `RefCell`, which provides interior mutability: a method to achieve mutability through a shared reference. `RefCell` enforces Rust's borrowing rules at runtime.

    use std::rc::Rc;
    use std::rc::Weak;
    use std::cell::RefCell;

    struct Owner {
        name: String,
        gadgets: RefCell<Vec<Weak<Gadget>>>,
        // ...other fields
    }

    struct Gadget {
        id: i32,
        owner: Rc<Owner>,
        // ...other fields
    }

    fn main() {
        // Create a reference-counted `Owner`. Note that we've put the `Owner`'s
        // vector of `Gadget`s inside a `RefCell` so that we can mutate it through
        // a shared reference.
        let gadget_owner: Rc<Owner> = Rc::new(
            Owner {
                name: "Gadget Man".to_string(),
                gadgets: RefCell::new(vec![]),
            }
        );

        // Create `Gadget`s belonging to `gadget_owner`, as before.
        let gadget1 = Rc::new(
            Gadget {
                id: 1,
                owner: gadget_owner.clone(),
            }
        );
        let gadget2 = Rc::new(
            Gadget {
                id: 2,
                owner: gadget_owner.clone(),
            }
        );

        // Add the `Gadget`s to their `Owner`.
        {
            let mut gadgets = gadget_owner.gadgets.borrow_mut();
            gadgets.push(Rc::downgrade(&gadget1));
            gadgets.push(Rc::downgrade(&gadget2));

            // `RefCell` dynamic borrow ends here.
        }

        // Iterate over our `Gadget`s, printing their details out.
        for gadget_weak in gadget_owner.gadgets.borrow().iter() {

            // `gadget_weak` is a `Weak<Gadget>`. Since `Weak` pointers can't
            // guarantee the value is still allocated, we need to call
            // `upgrade`, which returns an `Option<Rc<Gadget>>`.
            //
            // In this case we know the value still exists, so we simply
            // `unwrap` the `Option`. In a more complicated program, you might
            // need graceful error handling for a `None` result.

            let gadget = gadget_weak.upgrade().unwrap();
            println!("Gadget {} owned by {}", gadget.id, gadget.owner.name);
        }

        // At the end of the function, `gadget_owner`, `gadget1`, and `gadget2`
        // are destroyed. There are now no strong (`Rc`) pointers to the
        // gadgets, so they are destroyed. This zeroes the reference count on
        // Gadget Man, so he gets destroyed as well.
    }Run

## Structs

Rc | A single-threaded reference-counting pointer.
Weak | A weak version of `Rc`.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)