alloc::rc::Rc - Rust
Description: API documentation for the Rust `Rc` struct in crate `alloc`.
Keywords: rust, rustlang, rust-lang, Rc

# Struct alloc::rc::Rc 1.0.0 [−] [src]

    pub struct Rc<T: ?Sized> { /* fields omitted */ }

A single-threaded reference-counting pointer. 'Rc' stands for 'Reference Counted'.

See the module-level documentation for more details.

The inherent methods of `Rc` are all associated functions, which means that you have to call them as e.g. `Rc::get_mut(&mut value)` instead of `value.get_mut()`. This avoids conflicts with methods of the inner type `T`.

## Methods

### `impl<T> Rc<T>`
[src]

#### `pub fn new(value: T) -> Rc<T>`
[src]

Constructs a new `Rc<T>`.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

#### `pub fn try_unwrap(this: Self) -> Result<T, Self>`
1.4.0
[src]

Returns the contained value, if the `Rc` has exactly one strong reference.

Otherwise, an `Err` is returned with the same `Rc` that was passed in.

This will succeed even if there are outstanding weak references.

# Examples

    use std::rc::Rc;

    let x = Rc::new(3);
    assert_eq!(Rc::try_unwrap(x), Ok(3));

    let x = Rc::new(4);
    let _y = Rc::clone(&x);
    assert_eq!(*Rc::try_unwrap(x).unwrap_err(), 4);

### `impl<T: ?Sized> Rc<T>`
[src]

#### `pub fn into_raw(this: Self) -> *const T`
1.17.0
[src]

Consumes the `Rc`, returning the wrapped pointer.

To avoid a memory leak the pointer must be converted back to an `Rc` using `Rc::from_raw`.

# Examples

    use std::rc::Rc;

    let x = Rc::new(10);
    let x_ptr = Rc::into_raw(x);
    assert_eq!(unsafe { *x_ptr }, 10);

#### `pub unsafe fn from_raw(ptr: *const T) -> Self`
1.17.0
[src]

Constructs an `Rc` from a raw pointer.

The raw pointer must have been previously returned by a call to a `Rc::into_raw`.

This function is unsafe because improper use may lead to memory problems. For example, a double-free may occur if the function is called twice on the same raw pointer.

# Examples

    use std::rc::Rc;

    let x = Rc::new(10);
    let x_ptr = Rc::into_raw(x);

    unsafe {
        // Convert back to an `Rc` to prevent leak.
        let x = Rc::from_raw(x_ptr);
        assert_eq!(*x, 10);

        // Further calls to `Rc::from_raw(x_ptr)` would be memory unsafe.
    }

    // The memory was freed when `x` went out of scope above, so `x_ptr` is now dangling!

#### `pub fn downgrade(this: &Self) -> Weak<T>`
1.4.0
[src]

Creates a new `Weak` pointer to this value.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    let weak_five = Rc::downgrade(&five);

#### `pub fn weak_count(this: &Self) -> usize`
1.15.0
[src]

Gets the number of `Weak` pointers to this value.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);
    let _weak_five = Rc::downgrade(&five);

    assert_eq!(1, Rc::weak_count(&five));

#### `pub fn strong_count(this: &Self) -> usize`
1.15.0
[src]

Gets the number of strong (`Rc`) pointers to this value.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);
    let _also_five = Rc::clone(&five);

    assert_eq!(2, Rc::strong_count(&five));

#### `pub fn get_mut(this: &mut Self) -> Option<&mut T>`
1.4.0
[src]

Returns a mutable reference to the inner value, if there are no other `Rc` or `Weak` pointers to the same value.

Returns `None` otherwise, because it is not safe to mutate a shared value.

See also `make_mut`, which will `clone` the inner value when it's shared.

# Examples

    use std::rc::Rc;

    let mut x = Rc::new(3);
    *Rc::get_mut(&mut x).unwrap() = 4;
    assert_eq!(*x, 4);

    let _y = Rc::clone(&x);
    assert!(Rc::get_mut(&mut x).is_none());

#### `pub fn ptr_eq(this: &Self, other: &Self) -> bool`
1.17.0
[src]

Returns true if the two `Rc`s point to the same value (not just values that compare as equal).

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);
    let same_five = Rc::clone(&five);
    let other_five = Rc::new(5);

    assert!(Rc::ptr_eq(&five, &same_five));
    assert!(!Rc::ptr_eq(&five, &other_five));

### `impl<T: Clone> Rc<T>`
[src]

#### `pub fn make_mut(this: &mut Self) -> &mut T`
1.4.0
[src]

Makes a mutable reference into the given `Rc`.

If there are other `Rc` or `Weak` pointers to the same value, then `make_mut` will invoke `clone` on the inner value to ensure unique ownership. This is also referred to as clone-on-write.

See also `get_mut`, which will fail rather than cloning.

# Examples

    use std::rc::Rc;

    let mut data = Rc::new(5);

    *Rc::make_mut(&mut data) += 1;        // Won't clone anything
    let mut other_data = Rc::clone(&data);    // Won't clone inner data
    *Rc::make_mut(&mut data) += 1;        // Clones inner data
    *Rc::make_mut(&mut data) += 1;        // Won't clone anything
    *Rc::make_mut(&mut other_data) *= 2;  // Won't clone anything

    // Now `data` and `other_data` point to different values.
    assert_eq!(*data, 8);
    assert_eq!(*other_data, 12);

### `impl Rc<Any>`
[src]

#### `pub fn downcast<T: Any>(self) -> Result<Rc<T>, Rc<Any>>`
[src]

🔬 This is a nightly-only experimental API. (`rc_downcast` #44608)

Attempt to downcast the `Rc<Any>` to a concrete type.

# Examples

    #![feature(rc_downcast)]
    use std::any::Any;
    use std::rc::Rc;

    fn print_if_string(value: Rc<Any>) {
        if let Ok(string) = value.downcast::<String>() {
            println!("String ({}): {}", string.len(), string);
        }
    }

    fn main() {
        let my_string = "Hello World".to_string();
        print_if_string(Rc::new(my_string));
        print_if_string(Rc::new(0i8));
    }

## Trait Implementations

### `impl<T: ?Sized> !Send for Rc<T>`
[src]

### `impl<T: ?Sized> !Sync for Rc<T>`
[src]

### `impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Rc<U>> for Rc<T>`
[src]

### `impl<T: ?Sized> Deref for Rc<T>`
[src]

#### `type Target = T`

The resulting type after dereferencing.

#### `fn deref(&self) -> &T`
[src]

Dereferences the value.

### `impl<T: ?Sized> Drop for Rc<T>`
[src]

#### `fn drop(&mut self)`
[src]

Drops the `Rc`.

This will decrement the strong reference count. If the strong reference count reaches zero then the only other references (if any) are `Weak`, so we `drop` the inner value.

# Examples

    use std::rc::Rc;

    struct Foo;

    impl Drop for Foo {
        fn drop(&mut self) {
            println!("dropped!");
        }
    }

    let foo  = Rc::new(Foo);
    let foo2 = Rc::clone(&foo);

    drop(foo);    // Doesn't print anything
    drop(foo2);   // Prints "dropped!"

### `impl<T: ?Sized> Clone for Rc<T>`
[src]

#### `fn clone(&self) -> Rc<T>`
[src]

Makes a clone of the `Rc` pointer.

This creates another pointer to the same inner value, increasing the strong reference count.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    Rc::clone(&five);

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl<T: Default> Default for Rc<T>`
[src]

#### `fn default() -> Rc<T>`
[src]

Creates a new `Rc<T>`, with the `Default` value for `T`.

# Examples

    use std::rc::Rc;

    let x: Rc<i32> = Default::default();
    assert_eq!(*x, 0);

### `impl<T: ?Sized + PartialEq> PartialEq for Rc<T>`
[src]

#### `fn eq(&self, other: &Rc<T>) -> bool`
[src]

Equality for two `Rc`s.

Two `Rc`s are equal if their inner values are equal.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five == Rc::new(5));

#### `fn ne(&self, other: &Rc<T>) -> bool`
[src]

Inequality for two `Rc`s.

Two `Rc`s are unequal if their inner values are unequal.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five != Rc::new(6));

### `impl<T: ?Sized + Eq> Eq for Rc<T>`
[src]

### `impl<T: ?Sized + PartialOrd> PartialOrd for Rc<T>`
[src]

#### `fn partial_cmp(&self, other: &Rc<T>) -> Option<Ordering>`
[src]

Partial comparison for two `Rc`s.

The two are compared by calling `partial_cmp()` on their inner values.

# Examples

    use std::rc::Rc;
    use std::cmp::Ordering;

    let five = Rc::new(5);

    assert_eq!(Some(Ordering::Less), five.partial_cmp(&Rc::new(6)));

#### `fn lt(&self, other: &Rc<T>) -> bool`
[src]

Less-than comparison for two `Rc`s.

The two are compared by calling `<` on their inner values.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five < Rc::new(6));

#### `fn le(&self, other: &Rc<T>) -> bool`
[src]

'Less than or equal to' comparison for two `Rc`s.

The two are compared by calling `<=` on their inner values.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five <= Rc::new(5));

#### `fn gt(&self, other: &Rc<T>) -> bool`
[src]

Greater-than comparison for two `Rc`s.

The two are compared by calling `>` on their inner values.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five > Rc::new(4));

#### `fn ge(&self, other: &Rc<T>) -> bool`
[src]

'Greater than or equal to' comparison for two `Rc`s.

The two are compared by calling `>=` on their inner values.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    assert!(five >= Rc::new(5));

### `impl<T: ?Sized + Ord> Ord for Rc<T>`
[src]

#### `fn cmp(&self, other: &Rc<T>) -> Ordering`
[src]

Comparison for two `Rc`s.

The two are compared by calling `cmp()` on their inner values.

# Examples

    use std::rc::Rc;
    use std::cmp::Ordering;

    let five = Rc::new(5);

    assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));

#### `fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

#### `fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

### `impl<T: ?Sized + Hash> Hash for Rc<T>`
[src]

#### `fn hash<H: Hasher>(&self, state: &mut H)`
[src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,`
1.3.0
[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl<T: ?Sized + Display> Display for Rc<T>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<T: ?Sized + Debug> Debug for Rc<T>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter. Read more

### `impl<T: ?Sized> Pointer for Rc<T>`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result`
[src]

Formats the value using the given formatter.

### `impl<T> From<T> for Rc<T>`
1.6.0
[src]

#### `fn from(t: T) -> Self`
[src]

Performs the conversion.

### `impl<'a, T: Clone> From<&'a [T]> for Rc<[T]>`
1.21.0
[src]

#### `fn from(v: &[T]) -> Rc<[T]>`
[src]

Performs the conversion.

### `impl<'a> From<&'a str> for Rc<str>`
1.21.0
[src]

#### `fn from(v: &str) -> Rc<str>`
[src]

Performs the conversion.

### `impl From<String> for Rc<str>`
1.21.0
[src]

#### `fn from(v: String) -> Rc<str>`
[src]

Performs the conversion.

### `impl<T: ?Sized> From<Box<T>> for Rc<T>`
1.21.0
[src]

#### `fn from(v: Box<T>) -> Rc<T>`
[src]

Performs the conversion.

### `impl<T> From<Vec<T>> for Rc<[T]>`
1.21.0
[src]

#### `fn from(v: Vec<T>) -> Rc<[T]>`
[src]

Performs the conversion.

### `impl<T: ?Sized> Borrow<T> for Rc<T>`
[src]

#### `fn borrow(&self) -> &T`
[src]

Immutably borrows from an owned value. Read more

### `impl<T: ?Sized> AsRef<T> for Rc<T>`
1.5.0
[src]

#### `fn as_ref(&self) -> &T`
[src]

Performs the conversion.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  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`)