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

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

    pub struct Rc<T> where
        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`.

## Implementations

### `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);

Run

#### `pub fn new_cyclic(data_fn: impl FnOnce(&Weak<T>) -> T) -> Rc<T>`[src]

🔬 This is a nightly-only experimental API. (`arc_new_cyclic` #75861)

Constructs a new `Rc<T>` using a weak reference to itself. Attempting to upgrade the weak reference before this function returns will result in a `None` value. However, the weak reference may be cloned freely and stored for use at a later time.

#### `pub fn new_uninit() -> Rc<MaybeUninit<T>>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Constructs a new `Rc` with uninitialized contents.

# Examples

    #![feature(new_uninit)]
    #![feature(get_mut_unchecked)]

    use std::rc::Rc;

    let mut five = Rc::<u32>::new_uninit();

    let five = unsafe {
        // Deferred initialization:
        Rc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);

        five.assume_init()
    };

    assert_eq!(*five, 5)

Run

#### `pub fn new_zeroed() -> Rc<MaybeUninit<T>>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Constructs a new `Rc` with uninitialized contents, with the memory being filled with `0` bytes.

See `MaybeUninit::zeroed` for examples of correct and incorrect usage of this method.

# Examples

    #![feature(new_uninit)]

    use std::rc::Rc;

    let zero = Rc::<u32>::new_zeroed();
    let zero = unsafe { zero.assume_init() };

    assert_eq!(*zero, 0)

Run

#### `pub fn pin(value: T) -> Pin<Rc<T>>ⓘ

### Notable traits for Pin<P>

`impl<P> Future for Pin<P> where
P: Unpin + DerefMut,
<P as Deref>::Target: Future, type Output = <<P as Deref>::Target as Future>::Output;`
`1.33.0[src]

Constructs a new `Pin<Rc<T>>`. If `T` does not implement `Unpin`, then `value` will be pinned in memory and unable to be moved.

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

Returns the inner 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);

Run

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

#### `pub fn new_uninit_slice(len: usize) -> Rc<[MaybeUninit<T>]>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Constructs a new reference-counted slice with uninitialized contents.

# Examples

    #![feature(new_uninit)]
    #![feature(get_mut_unchecked)]

    use std::rc::Rc;

    let mut values = Rc::<[u32]>::new_uninit_slice(3);

    let values = unsafe {
        // Deferred initialization:
        Rc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
        Rc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
        Rc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);

        values.assume_init()
    };

    assert_eq!(*values, [1, 2, 3])

Run

#### `pub fn new_zeroed_slice(len: usize) -> Rc<[MaybeUninit<T>]>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Constructs a new reference-counted slice with uninitialized contents, with the memory being filled with `0` bytes.

See `MaybeUninit::zeroed` for examples of correct and incorrect usage of this method.

# Examples

    #![feature(new_uninit)]

    use std::rc::Rc;

    let values = Rc::<[u32]>::new_zeroed_slice(3);
    let values = unsafe { values.assume_init() };

    assert_eq!(*values, [0, 0, 0])

Run

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

#### `pub unsafe fn assume_init(self) -> Rc<T>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Converts to `Rc<T>`.

# Safety

As with `MaybeUninit::assume_init`, it is up to the caller to guarantee that the inner value really is in an initialized state. Calling this when the content is not yet fully initialized causes immediate undefined behavior.

# Examples

    #![feature(new_uninit)]
    #![feature(get_mut_unchecked)]

    use std::rc::Rc;

    let mut five = Rc::<u32>::new_uninit();

    let five = unsafe {
        // Deferred initialization:
        Rc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);

        five.assume_init()
    };

    assert_eq!(*five, 5)

Run

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

#### `pub unsafe fn assume_init(self) -> Rc<[T]>`[src]

🔬 This is a nightly-only experimental API. (`new_uninit` #63291)

Converts to `Rc<[T]>`.

# Safety

As with `MaybeUninit::assume_init`, it is up to the caller to guarantee that the inner value really is in an initialized state. Calling this when the content is not yet fully initialized causes immediate undefined behavior.

# Examples

    #![feature(new_uninit)]
    #![feature(get_mut_unchecked)]

    use std::rc::Rc;

    let mut values = Rc::<[u32]>::new_uninit_slice(3);

    let values = unsafe {
        // Deferred initialization:
        Rc::get_mut_unchecked(&mut values)[0].as_mut_ptr().write(1);
        Rc::get_mut_unchecked(&mut values)[1].as_mut_ptr().write(2);
        Rc::get_mut_unchecked(&mut values)[2].as_mut_ptr().write(3);

        values.assume_init()
    };

    assert_eq!(*values, [1, 2, 3])

Run

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

#### `pub fn into_raw(this: Rc<T>) -> *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("hello".to_owned());
    let x_ptr = Rc::into_raw(x);
    assert_eq!(unsafe { &*x_ptr }, "hello");

Run

#### `pub fn as_ptr(this: &Rc<T>) -> *const T`1.45.0[src]

Provides a raw pointer to the data.

The counts are not affected in any way and the `Rc` is not consumed. The pointer is valid for as long there are strong counts in the `Rc`.

# Examples

    use std::rc::Rc;

    let x = Rc::new("hello".to_owned());
    let y = Rc::clone(&x);
    let x_ptr = Rc::as_ptr(&x);
    assert_eq!(x_ptr, Rc::as_ptr(&y));
    assert_eq!(unsafe { &*x_ptr }, "hello");

Run

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

Constructs an `Rc<T>` from a raw pointer.

The raw pointer must have been previously returned by a call to `Rc<U>::into_raw` where `U` must have the same size and alignment as `T`. This is trivially true if `U` is `T`. Note that if `U` is not `T` but has the same size and alignment, this is basically like transmuting references of different types. See `mem::transmute` for more information on what restrictions apply in this case.

The user of `from_raw` has to make sure a specific value of `T` is only dropped once.

This function is unsafe because improper use may lead to memory unsafety, even if the returned `Rc<T>` is never accessed.

# Examples

    use std::rc::Rc;

    let x = Rc::new("hello".to_owned());
    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, "hello");

        // 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!

Run

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

Creates a new `Weak` pointer to this allocation.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

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

Run

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

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

# Examples

    use std::rc::Rc;

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

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

Run

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

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

# Examples

    use std::rc::Rc;

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

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

Run

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

Returns a mutable reference into the given `Rc`, if there are no other `Rc` or `Weak` pointers to the same allocation.

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

See also `make_mut`, which will `clone` the inner value when there are other pointers.

# 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());

Run

#### `pub unsafe fn get_mut_unchecked(this: &mut Rc<T>) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

🔬 This is a nightly-only experimental API. (`get_mut_unchecked` #63292)

Returns a mutable reference into the given `Rc`, without any check.

See also `get_mut`, which is safe and does appropriate checks.

# Safety

Any other `Rc` or `Weak` pointers to the same allocation must not be dereferenced for the duration of the returned borrow. This is trivially the case if no such pointers exist, for example immediately after `Rc::new`.

# Examples

    #![feature(get_mut_unchecked)]

    use std::rc::Rc;

    let mut x = Rc::new(String::new());
    unsafe {
        Rc::get_mut_unchecked(&mut x).push_str("foo")
    }
    assert_eq!(*x, "foo");

Run

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

Returns `true` if the two `Rc`s point to the same allocation (in a vein similar to `ptr::eq`).

# 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));

Run

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

#### `pub fn make_mut(this: &mut Rc<T>) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`1.4.0[src]

Makes a mutable reference into the given `Rc`.

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

If there are no other `Rc` pointers to this allocation, then `Weak` pointers to this allocation will be disassociated.

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 allocations.
    assert_eq!(*data, 8);
    assert_eq!(*other_data, 12);

Run

`Weak` pointers will be disassociated:

    use std::rc::Rc;

    let mut data = Rc::new(75);
    let weak = Rc::downgrade(&data);

    assert!(75 == *data);
    assert!(75 == *weak.upgrade().unwrap());

    *Rc::make_mut(&mut data) += 1;

    assert!(76 == *data);
    assert!(weak.upgrade().is_none());

Run

### `impl Rc<dyn Any + 'static>`[src]

#### `pub fn downcast<T>(self) -> Result<Rc<T>, Rc<dyn Any + 'static>> where
T: Any,` 1.29.0[src]

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

# Examples

    use std::any::Any;
    use std::rc::Rc;

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

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

Run

## Trait Implementations

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

#### `pub fn as_ref(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Performs the conversion.

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

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Immutably borrows from an owned value. Read more

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

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

Makes a clone of the `Rc` pointer.

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

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

    let _ = Rc::clone(&five);

Run

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

Performs copy-assignment from `source`. Read more

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

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

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

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

#### `pub 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);

Run

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

#### `type Target = T`

The resulting type after dereferencing.

#### `pub fn deref(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Dereferences the value.

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

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

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter. Read more

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

#### `pub 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!"

Run

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

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

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

Performs the conversion.

### `impl<'_> From<&'_ CStr> for Rc<CStr>`1.24.0[src]

#### `fn from(s: &CStr) -> Rc<CStr>`[src]

Performs the conversion.

### `impl<'_> From<&'_ OsStr> for Rc<OsStr>`1.24.0[src]

#### `fn from(s: &OsStr) -> Rc<OsStr>`[src]

Performs the conversion.

### `impl<'_> From<&'_ Path> for Rc<Path>`1.24.0[src]

#### `fn from(s: &Path) -> Rc<Path>`[src]

Converts a `Path` into an `Rc` by copying the `Path` data into a new `Rc` buffer.

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

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

Performs the conversion.

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

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

Performs the conversion.

### `impl From<CString> for Rc<CStr>`1.24.0[src]

#### `fn from(s: CString) -> Rc<CStr>`[src]

Converts a `CString` into a `Rc``<CStr>` without copying or allocating.

### `impl<'a, B> From<Cow<'a, B>> for Rc<B> where
B: ToOwned + ?Sized,
Rc<B>: From<&'a B>,
Rc<B>: From<<B as ToOwned>::Owned>,` 1.45.0[src]

#### `pub fn from(cow: Cow<'a, B>) -> Rc<B>`[src]

Performs the conversion.

### `impl From<OsString> for Rc<OsStr>`1.24.0[src]

#### `fn from(s: OsString) -> Rc<OsStr>`[src]

Converts a `OsString` into a `Rc``<OsStr>` without copying or allocating.

### `impl From<PathBuf> for Rc<Path>`1.24.0[src]

#### `fn from(s: PathBuf) -> Rc<Path>`[src]

Converts a `PathBuf` into an `Rc` by moving the `PathBuf` data into a new `Rc` buffer.

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

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

Performs the conversion.

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

#### `pub fn from(t: T) -> Rc<T>`[src]

Performs the conversion.

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

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

Performs the conversion.

### `impl<T> FromIterator<T> for Rc<[T]>`1.37.0[src]

#### `pub fn from_iter<I>(iter: I) -> Rc<[T]> where
I: IntoIterator<Item = T>,` [src]

Takes each element in the `Iterator` and collects it into an `Rc<[T]>`.

# Performance characteristics

## The general case

In the general case, collecting into `Rc<[T]>` is done by first collecting into a `Vec<T>`. That is, when writing the following:

    let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();

Run

this behaves as if we wrote:

    let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
        .collect::<Vec<_>>() // The first set of allocations happens here.
        .into(); // A second allocation for `Rc<[T]>` happens here.

Run

This will allocate as many times as needed for constructing the `Vec<T>` and then it will allocate once for turning the `Vec<T>` into the `Rc<[T]>`.

## Iterators of known length

When your `Iterator` implements `TrustedLen` and is of an exact size, a single allocation will be made for the `Rc<[T]>`. For example:

    let evens: Rc<[u8]> = (0..10).collect(); // Just a single allocation happens here.

Run

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

#### `pub fn hash<H>(&self, state: &mut H) where
H: Hasher,` [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> Ord for Rc<T> where
T: Ord + ?Sized,` [src]

#### `pub 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)));

Run

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

#### `#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

🔬 This is a nightly-only experimental API. (`clamp` #44095)

Restrict a value to a certain interval. Read more

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

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

Equality for two `Rc`s.

Two `Rc`s are equal if their inner values are equal, even if they are stored in different allocation.

If `T` also implements `Eq` (implying reflexivity of equality), two `Rc`s that point to the same allocation are always equal.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

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

Run

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

Inequality for two `Rc`s.

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

If `T` also implements `Eq` (implying reflexivity of equality), two `Rc`s that point to the same allocation are never unequal.

# Examples

    use std::rc::Rc;

    let five = Rc::new(5);

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

Run

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

#### `pub 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)));

Run

#### `pub 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));

Run

#### `pub 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));

Run

#### `pub 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));

Run

#### `pub 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));

Run

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

#### `pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>`[src]

Formats the value using the given formatter.

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

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

### `impl<T, const N: usize> TryFrom<Rc<[T]>> for Rc<[T; N]>`1.43.0[src]

#### `type Error = Rc<[T]>`

The type returned in the event of a conversion error.

#### `pub fn try_from(
boxed_slice: Rc<[T]>
) -> Result<Rc<[T; N]>, <Rc<[T; N]> as TryFrom<Rc<[T]>>>::Error>`[src]

Performs the conversion.

### `impl<T> Unpin for Rc<T> where
T: ?Sized,` 1.33.0[src]

### `impl<T: RefUnwindSafe + ?Sized> UnwindSafe for Rc<T>`1.9.0[src]

## Auto Trait Implementations

### `impl<T> !RefUnwindSafe for Rc<T>`

## Blanket Implementations

### `impl<T> Any for T where
T: 'static + ?Sized,` [src]

#### `pub fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

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

#### `pub fn borrow(&self) -> &Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Immutably borrows from an owned value. Read more

### `impl<T> BorrowMut<T> for T where
T: ?Sized,` [src]

#### `pub fn borrow_mut(&mut self) -> &mut Tⓘ

### Notable traits for &'_ mut I

`impl<'_, I> Iterator for &'_ mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where
F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;impl<R: Read + ?Sized, '_> Read for &'_ mut Rimpl<W: Write + ?Sized, '_> Write for &'_ mut W`
`[src]

Mutably borrows from an owned value. Read more

### `impl<T> From<!> for T`[src]

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

Performs the conversion.

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

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

Performs the conversion.

### `impl<T, U> Into<U> for T where
U: From<T>,` [src]

#### `pub fn into(self) -> U`[src]

Performs the conversion.

### `impl<T> ToOwned for T where
T: Clone,` [src]

#### `type Owned = T`

The resulting type after obtaining ownership.

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

Creates owned data from borrowed data, usually by cloning. Read more

#### `pub fn clone_into(&self, target: &mut T)`[src]

🔬 This is a nightly-only experimental API. (`toowned_clone_into` #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

### `impl<T> ToString for T where
T: Display + ?Sized,` [src]

#### `pub default fn to_string(&self) -> String`[src]

Converts the given value to a `String`. Read more

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

### `impl<T, U> TryInto<U> for T where
U: TryFrom<T>,` [src]

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.