pub struct Rc<T: ?Sized, A: Allocator = Global> { }
Expand description
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
.
Constructs a new Rc<T>
.
use std::rc::Rc;
let five = Rc::new(5);
1.60.0 · Source
Constructs a new Rc<T>
while giving you a Weak<T>
to the allocation, to allow you to construct a T
which holds a weak pointer to itself.
Generally, a structure circularly referencing itself, either directly or indirectly, should not hold a strong reference to itself to prevent a memory leak. Using this function, you get access to the weak pointer during the initialization of T
, before the Rc<T>
is created, such that you can clone and store it inside the T
.
new_cyclic
first allocates the managed allocation for the Rc<T>
, then calls your closure, giving it a Weak<T>
to this allocation, and only afterwards completes the construction of the Rc<T>
by placing the T
returned from your closure into the allocation.
Since the new Rc<T>
is not fully-constructed until Rc<T>::new_cyclic
returns, calling upgrade
on the weak reference inside your closure will fail and result in a None
value.
If data_fn
panics, the panic is propagated to the caller, and the temporary Weak<T>
is dropped normally.
use std::rc::{Rc, Weak};
struct Gadget {
me: Weak<Gadget>,
}
impl Gadget {
fn new() -> Rc<Self> {
Rc::new_cyclic(|me| {
Gadget { me: me.clone() }
})
}
fn me(&self) -> Rc<Self> {
self.me.upgrade().unwrap()
}
}
1.82.0 · Source
Constructs a new Rc
with uninitialized contents.
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let mut five = Rc::<u32>::new_uninit();
Rc::get_mut(&mut five).unwrap().write(5);
let five = unsafe { five.assume_init() };
assert_eq!(*five, 5)
Source ð¬This is a nightly-only experimental API. (new_zeroed_alloc
#129396)
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.
#![feature(new_zeroed_alloc)]
use std::rc::Rc;
let zero = Rc::<u32>::new_zeroed();
let zero = unsafe { zero.assume_init() };
assert_eq!(*zero, 0)
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc<T>
, returning an error if the allocation fails
#![feature(allocator_api)]
use std::rc::Rc;
let five = Rc::try_new(5);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents, returning an error if the allocation fails
#![feature(allocator_api)]
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let mut five = Rc::<u32>::try_new_uninit()?;
Rc::get_mut(&mut five).unwrap().write(5);
let five = unsafe { five.assume_init() };
assert_eq!(*five, 5);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents, with the memory being filled with 0
bytes, returning an error if the allocation fails
See MaybeUninit::zeroed
for examples of correct and incorrect usage of this method.
#![feature(allocator_api)]
use std::rc::Rc;
let zero = Rc::<u32>::try_new_zeroed()?;
let zero = unsafe { zero.assume_init() };
assert_eq!(*zero, 0);
1.33.0 · Source
Constructs a new Pin<Rc<T>>
. If T
does not implement Unpin
, then value
will be pinned in memory and unable to be moved.
allocator_api
#32838)
Constructs a new Rc
in the provided allocator.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let five = Rc::new_in(5, System);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents in the provided allocator.
#![feature(get_mut_unchecked)]
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let mut five = Rc::<u32, _>::new_uninit_in(System);
let five = unsafe {
Rc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
five.assume_init()
};
assert_eq!(*five, 5)
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents, with the memory being filled with 0
bytes, in the provided allocator.
See MaybeUninit::zeroed
for examples of correct and incorrect usage of this method.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let zero = Rc::<u32, _>::new_zeroed_in(System);
let zero = unsafe { zero.assume_init() };
assert_eq!(*zero, 0)
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc<T, A>
in the given allocator while giving you a Weak<T, A>
to the allocation, to allow you to construct a T
which holds a weak pointer to itself.
Generally, a structure circularly referencing itself, either directly or indirectly, should not hold a strong reference to itself to prevent a memory leak. Using this function, you get access to the weak pointer during the initialization of T
, before the Rc<T, A>
is created, such that you can clone and store it inside the T
.
new_cyclic_in
first allocates the managed allocation for the Rc<T, A>
, then calls your closure, giving it a Weak<T, A>
to this allocation, and only afterwards completes the construction of the Rc<T, A>
by placing the T
returned from your closure into the allocation.
Since the new Rc<T, A>
is not fully-constructed until Rc<T, A>::new_cyclic_in
returns, calling upgrade
on the weak reference inside your closure will fail and result in a None
value.
If data_fn
panics, the panic is propagated to the caller, and the temporary Weak<T, A>
is dropped normally.
See new_cyclic
.
allocator_api
#32838)
Constructs a new Rc<T>
in the provided allocator, returning an error if the allocation fails
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let five = Rc::try_new_in(5, System);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents, in the provided allocator, returning an error if the allocation fails
#![feature(allocator_api)]
#![feature(get_mut_unchecked)]
use std::rc::Rc;
use std::alloc::System;
let mut five = Rc::<u32, _>::try_new_uninit_in(System)?;
let five = unsafe {
Rc::get_mut_unchecked(&mut five).as_mut_ptr().write(5);
five.assume_init()
};
assert_eq!(*five, 5);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Rc
with uninitialized contents, with the memory being filled with 0
bytes, in the provided allocator, returning an error if the allocation fails
See MaybeUninit::zeroed
for examples of correct and incorrect usage of this method.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let zero = Rc::<u32, _>::try_new_zeroed_in(System)?;
let zero = unsafe { zero.assume_init() };
assert_eq!(*zero, 0);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs a new Pin<Rc<T>>
in the provided allocator. If T
does not implement Unpin
, then value
will be pinned in memory and unable to be moved.
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.
§Examplesuse 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);
1.70.0 · Source
Returns the inner value, if the Rc
has exactly one strong reference.
Otherwise, None
is returned and the Rc
is dropped.
This will succeed even if there are outstanding weak references.
If Rc::into_inner
is called on every clone of this Rc
, it is guaranteed that exactly one of the calls returns the inner value. This means in particular that the inner value is not dropped.
Rc::try_unwrap
is conceptually similar to Rc::into_inner
. And while they are meant for different use-cases, Rc::into_inner(this)
is in fact equivalent to Rc::try_unwrap(this).ok()
. (Note that the same kind of equivalence does not hold true for Arc
, due to race conditions that do not apply to Rc
!)
use std::rc::Rc;
let x = Rc::new(3);
assert_eq!(Rc::into_inner(x), Some(3));
let x = Rc::new(4);
let y = Rc::clone(&x);
assert_eq!(Rc::into_inner(y), None);
assert_eq!(Rc::into_inner(x), Some(4));
Source§ 1.82.0 · Source
Constructs a new reference-counted slice with uninitialized contents.
§Examples#![feature(get_mut_unchecked)]
use std::rc::Rc;
let mut values = Rc::<[u32]>::new_uninit_slice(3);
let data = Rc::get_mut(&mut values).unwrap();
data[0].write(1);
data[1].write(2);
data[2].write(3);
let values = unsafe { values.assume_init() };
assert_eq!(*values, [1, 2, 3])
Source ð¬This is a nightly-only experimental API. (new_zeroed_alloc
#129396)
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.
#![feature(new_zeroed_alloc)]
use std::rc::Rc;
let values = Rc::<[u32]>::new_zeroed_slice(3);
let values = unsafe { values.assume_init() };
assert_eq!(*values, [0, 0, 0])
Source ð¬This is a nightly-only experimental API. (slice_as_array
#133508)
Converts the reference-counted slice into a reference-counted array.
This operation does not reallocate; the underlying array of the slice is simply reinterpreted as an array type.
If N
is not exactly equal to the length of self
, then this method returns None
.
allocator_api
#32838)
Constructs a new reference-counted slice with uninitialized contents.
§Examples#![feature(get_mut_unchecked)]
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let mut values = Rc::<[u32], _>::new_uninit_slice_in(3, System);
let values = unsafe {
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])
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
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.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let values = Rc::<[u32], _>::new_zeroed_slice_in(3, System);
let values = unsafe { values.assume_init() };
assert_eq!(*values, [0, 0, 0])
Source§ 1.82.0 · Source
Converts to Rc<T>
.
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.
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let mut five = Rc::<u32>::new_uninit();
Rc::get_mut(&mut five).unwrap().write(5);
let five = unsafe { five.assume_init() };
assert_eq!(*five, 5)
Source§ 1.82.0 · Source
Converts to Rc<[T]>
.
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.
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let mut values = Rc::<[u32]>::new_uninit_slice(3);
let data = Rc::get_mut(&mut values).unwrap();
data[0].write(1);
data[1].write(2);
data[2].write(3);
let values = unsafe { values.assume_init() };
assert_eq!(*values, [1, 2, 3])
Source§ 1.17.0 · Source
Constructs an Rc<T>
from a raw pointer.
The raw pointer must have been previously returned by a call to Rc<U>::into_raw
with the following requirements:
U
is sized, it must have the same size and alignment as T
. This is trivially true if U
is T
.U
is unsized, its data pointer must have the same size and alignment as T
. This is trivially true if Rc<U>
was constructed through Rc<T>
and then converted to Rc<U>
through an unsized coercion.Note that if U
or U
âs data pointer 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 raw pointer must point to a block of memory allocated by the global allocator
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.
use std::rc::Rc;
let x = Rc::new("hello".to_owned());
let x_ptr = Rc::into_raw(x);
unsafe {
let x = Rc::from_raw(x_ptr);
assert_eq!(&*x, "hello");
}
Convert a slice back into its original array:
use std::rc::Rc;
let x: Rc<[u32]> = Rc::new([1, 2, 3]);
let x_ptr: *const [u32] = Rc::into_raw(x);
unsafe {
let x: Rc<[u32; 3]> = Rc::from_raw(x_ptr.cast::<[u32; 3]>());
assert_eq!(&*x, &[1, 2, 3]);
}
1.17.0 · Source
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
.
use std::rc::Rc;
let x = Rc::new("hello".to_owned());
let x_ptr = Rc::into_raw(x);
assert_eq!(unsafe { &*x_ptr }, "hello");
1.53.0 · Source
Increments the strong reference count on the Rc<T>
associated with the provided pointer by one.
The pointer must have been obtained through Rc::into_raw
and must satisfy the same layout requirements specified in Rc::from_raw_in
. The associated Rc
instance must be valid (i.e. the strong count must be at least 1) for the duration of this method, and ptr
must point to a block of memory allocated by the global allocator.
use std::rc::Rc;
let five = Rc::new(5);
unsafe {
let ptr = Rc::into_raw(five);
Rc::increment_strong_count(ptr);
let five = Rc::from_raw(ptr);
assert_eq!(2, Rc::strong_count(&five));
}
1.53.0 · Source
Decrements the strong reference count on the Rc<T>
associated with the provided pointer by one.
The pointer must have been obtained through Rc::into_raw
and must satisfy the same layout requirements specified in Rc::from_raw_in
. The associated Rc
instance must be valid (i.e. the strong count must be at least 1) when invoking this method, and ptr
must point to a block of memory allocated by the global allocator. This method can be used to release the final Rc
and backing storage, but should not be called after the final Rc
has been released.
use std::rc::Rc;
let five = Rc::new(5);
unsafe {
let ptr = Rc::into_raw(five);
Rc::increment_strong_count(ptr);
let five = Rc::from_raw(ptr);
assert_eq!(2, Rc::strong_count(&five));
Rc::decrement_strong_count(ptr);
assert_eq!(1, Rc::strong_count(&five));
}
Source§ Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Returns a reference to the underlying allocator.
Note: this is an associated function, which means that you have to call it as Rc::allocator(&r)
instead of r.allocator()
. This is so that there is no conflict with a method on the inner type.
allocator_api
#32838)
Consumes the Rc
, returning the wrapped pointer and allocator.
To avoid a memory leak the pointer must be converted back to an Rc
using Rc::from_raw_in
.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let x = Rc::new_in("hello".to_owned(), System);
let (ptr, alloc) = Rc::into_raw_with_allocator(x);
assert_eq!(unsafe { &*ptr }, "hello");
let x = unsafe { Rc::from_raw_in(ptr, alloc) };
assert_eq!(&*x, "hello");
1.45.0 · Source
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 as there are strong counts in the Rc
.
use std::rc::Rc;
let x = Rc::new(0);
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 }, 0);
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Constructs an Rc<T, A>
from a raw pointer in the provided allocator.
The raw pointer must have been previously returned by a call to Rc<U, A>::into_raw
with the following requirements:
U
is sized, it must have the same size and alignment as T
. This is trivially true if U
is T
.U
is unsized, its data pointer must have the same size and alignment as T
. This is trivially true if Rc<U>
was constructed through Rc<T>
and then converted to Rc<U>
through an unsized coercion.Note that if U
or U
âs data pointer 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 raw pointer must point to a block of memory allocated by alloc
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.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let x = Rc::new_in("hello".to_owned(), System);
let (x_ptr, _alloc) = Rc::into_raw_with_allocator(x);
unsafe {
let x = Rc::from_raw_in(x_ptr, System);
assert_eq!(&*x, "hello");
}
Convert a slice back into its original array:
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let x: Rc<[u32], _> = Rc::new_in([1, 2, 3], System);
let x_ptr: *const [u32] = Rc::into_raw_with_allocator(x).0;
unsafe {
let x: Rc<[u32; 3], _> = Rc::from_raw_in(x_ptr.cast::<[u32; 3]>(), System);
assert_eq!(&*x, &[1, 2, 3]);
}
1.4.0 · Source
Creates a new Weak
pointer to this allocation.
use std::rc::Rc;
let five = Rc::new(5);
let weak_five = Rc::downgrade(&five);
1.15.0 · Source
Gets the number of Weak
pointers to this allocation.
use std::rc::Rc;
let five = Rc::new(5);
let _weak_five = Rc::downgrade(&five);
assert_eq!(1, Rc::weak_count(&five));
1.15.0 · Source
Gets the number of strong (Rc
) pointers to this allocation.
use std::rc::Rc;
let five = Rc::new(5);
let _also_five = Rc::clone(&five);
assert_eq!(2, Rc::strong_count(&five));
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Increments the strong reference count on the Rc<T>
associated with the provided pointer by one.
The pointer must have been obtained through Rc::into_raw
and must satisfy the same layout requirements specified in Rc::from_raw_in
. The associated Rc
instance must be valid (i.e. the strong count must be at least 1) for the duration of this method, and ptr
must point to a block of memory allocated by alloc
.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let five = Rc::new_in(5, System);
unsafe {
let (ptr, _alloc) = Rc::into_raw_with_allocator(five);
Rc::increment_strong_count_in(ptr, System);
let five = Rc::from_raw_in(ptr, System);
assert_eq!(2, Rc::strong_count(&five));
}
Source ð¬This is a nightly-only experimental API. (allocator_api
#32838)
Decrements the strong reference count on the Rc<T>
associated with the provided pointer by one.
The pointer must have been obtained through Rc::into_raw
and must satisfy the same layout requirements specified in Rc::from_raw_in
. The associated Rc
instance must be valid (i.e. the strong count must be at least 1) when invoking this method, and ptr
must point to a block of memory allocated by alloc
. This method can be used to release the final Rc
and backing storage, but should not be called after the final Rc
has been released.
#![feature(allocator_api)]
use std::rc::Rc;
use std::alloc::System;
let five = Rc::new_in(5, System);
unsafe {
let (ptr, _alloc) = Rc::into_raw_with_allocator(five);
Rc::increment_strong_count_in(ptr, System);
let five = Rc::from_raw_in(ptr, System);
assert_eq!(2, Rc::strong_count(&five));
Rc::decrement_strong_count_in(ptr, System);
assert_eq!(1, Rc::strong_count(&five));
}
1.4.0 · Source
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 Rc
pointers.
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());
Source ð¬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.
If any other Rc
or Weak
pointers to the same allocation exist, then they must not be dereferenced or have active borrows for the duration of the returned borrow, and their inner type must be exactly the same as the inner type of this Rc (including lifetimes). This is trivially the case if no such pointers exist, for example immediately after Rc::new
.
#![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");
Other Rc
pointers to the same allocation must be to the same type.
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let x: Rc<str> = Rc::from("Hello, world!");
let mut y: Rc<[u8]> = x.clone().into();
unsafe {
Rc::get_mut_unchecked(&mut y).fill(0xff); }
println!("{}", &*x);
Other Rc
pointers to the same allocation must be to the exact same type, including lifetimes.
#![feature(get_mut_unchecked)]
use std::rc::Rc;
let x: Rc<&str> = Rc::new("Hello, world!");
{
let s = String::from("Oh, no!");
let mut y: Rc<&str> = x.clone();
unsafe {
*Rc::get_mut_unchecked(&mut y) = &s;
}
}
println!("{}", &*x);
1.17.0 · Source
Returns true
if the two Rc
s point to the same allocation in a vein similar to ptr::eq
. This function ignores the metadata of dyn Trait
pointers.
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));
Source§ 1.4.0 · Source
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.
However, if there are no other Rc
pointers to this allocation, but some Weak
pointers, then the Weak
pointers will be disassociated and the inner value will not be cloned.
See also get_mut
, which will fail rather than cloning the inner value or disassociating Weak
pointers.
use std::rc::Rc;
let mut data = Rc::new(5);
*Rc::make_mut(&mut data) += 1; let mut other_data = Rc::clone(&data); *Rc::make_mut(&mut data) += 1; *Rc::make_mut(&mut data) += 1; *Rc::make_mut(&mut other_data) *= 2; assert_eq!(*data, 8);
assert_eq!(*other_data, 12);
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());
Source§ 1.76.0 · Source
If we have the only reference to T
then unwrap it. Otherwise, clone T
and return the clone.
Assuming rc_t
is of type Rc<T>
, this function is functionally equivalent to (*rc_t).clone()
, but will avoid cloning the inner value where possible.
let inner = String::from("test");
let ptr = inner.as_ptr();
let rc = Rc::new(inner);
let inner = Rc::unwrap_or_clone(rc);
assert!(ptr::eq(ptr, inner.as_ptr()));
let rc = Rc::new(inner);
let rc2 = rc.clone();
let inner = Rc::unwrap_or_clone(rc);
assert!(!ptr::eq(ptr, inner.as_ptr()));
let inner = Rc::unwrap_or_clone(rc2);
assert!(ptr::eq(ptr, inner.as_ptr()));
Source§ 1.29.0 · Source
Attempts to downcast the Rc<dyn Any>
to a concrete type.
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));
Source ð¬This is a nightly-only experimental API. (downcast_unchecked
#90850)
Downcasts the Rc<dyn Any>
to a concrete type.
For a safe alternative see downcast
.
#![feature(downcast_unchecked)]
use std::any::Any;
use std::rc::Rc;
let x: Rc<dyn Any> = Rc::new(1_usize);
unsafe {
assert_eq!(*x.downcast_unchecked::<usize>(), 1);
}
§Safety
The contained value must be of type T
. Calling this method with the incorrect type is undefined behavior.
Converts this type into a shared reference of the (usually inferred) input type.
1.0.0 · Source§ 1.0.0 · Source§ Source§Makes a clone of the Rc
pointer.
This creates another pointer to the same allocation, increasing the strong reference count.
§Examplesuse std::rc::Rc;
let five = Rc::new(5);
let _ = Rc::clone(&five);
1.0.0 · Source§
Performs copy-assignment from
source
.
Read more 1.0.0 · Source§ 1.91.0 · Source§ 1.80.0 · Source§ Source§Creates an empty [T]
inside an Rc
.
This may or may not share an allocation with other Rcs on the same thread.
1.80.0 · Source§ Source§Creates an empty CStr inside an Rc
This may or may not share an allocation with other Rcs on the same thread.
1.0.0 · Source§ Source§Creates a new Rc<T>
, with the Default
value for T
.
use std::rc::Rc;
let x: Rc<i32> = Default::default();
assert_eq!(*x, 0);
1.80.0 · Source§ Source§
Creates an empty str
inside an Rc
.
This may or may not share an allocation with other Rcs on the same thread.
1.0.0 · Source§ Source§The resulting type after dereferencing.
Source§Dereferences the value.
1.0.0 · Source§ 1.0.0 · Source§ Source§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.
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); drop(foo2);
1.21.0 · Source§ Source§
Allocates a reference-counted slice and fills it by cloning v
âs items.
let original: &[i32] = &[1, 2, 3];
let shared: Rc<[i32]> = Rc::from(original);
assert_eq!(&[1, 2, 3], &shared[..]);
1.24.0 · Source§ Source§
Converts a &CStr
into a Rc<CStr>
, by copying the contents into a newly allocated Rc
.
Allocates a reference-counted slice and fills it by cloning v
âs items.
let mut original = [1, 2, 3];
let original: &mut [i32] = &mut original;
let shared: Rc<[i32]> = Rc::from(original);
assert_eq!(&[1, 2, 3], &shared[..]);
1.84.0 · Source§ Source§
Converts a &mut CStr
into a Rc<CStr>
, by copying the contents into a newly allocated Rc
.
Allocates a reference-counted string slice and copies v
into it.
let mut original = String::from("statue");
let original: &mut str = &mut original;
let shared: Rc<str> = Rc::from(original);
assert_eq!("statue", &shared[..]);
1.21.0 · Source§ Source§
Allocates a reference-counted string slice and copies v
into it.
let shared: Rc<str> = Rc::from("statue");
assert_eq!("statue", &shared[..]);
1.74.0 · Source§ Source§
Converts a [T; N]
into an Rc<[T]>
.
The conversion moves the array into a newly allocated Rc
.
let original: [i32; 3] = [1, 2, 3];
let shared: Rc<[i32]> = Rc::from(original);
assert_eq!(&[1, 2, 3], &shared[..]);
1.21.0 · Source§ Source§
Move a boxed object to a new, reference counted, allocation.
§Examplelet original: Box<i32> = Box::new(1);
let shared: Rc<i32> = Rc::from(original);
assert_eq!(1, *shared);
1.24.0 · Source§ 1.45.0 · Source§ Source§
Creates a reference-counted pointer from a clone-on-write pointer by copying its content.
§Examplelet cow: Cow<'_, str> = Cow::Borrowed("eggplant");
let shared: Rc<str> = Rc::from(cow);
assert_eq!("eggplant", &shared[..]);
Source§ Source§
Converts to this type from the input type.
Source§ Source§Converts to this type from the input type.
Source§ Source§Use a Wake
-able type as a LocalWaker
.
No heap allocations or atomic operations are used for this conversion.
Source§ Source§Use a Wake
-able type as a RawWaker
.
No heap allocations or atomic operations are used for this conversion.
1.62.0 · Source§ Source§Converts a reference-counted string slice into a byte slice.
§Examplelet string: Rc<str> = Rc::from("eggplant");
let bytes: Rc<[u8]> = Rc::from(string);
assert_eq!("eggplant".as_bytes(), bytes.as_ref());
1.21.0 · Source§ Source§
Allocates a reference-counted string slice and copies v
into it.
let original: String = "statue".to_owned();
let shared: Rc<str> = Rc::from(original);
assert_eq!("statue", &shared[..]);
1.6.0 · Source§ Source§
Converts a generic type T
into an Rc<T>
The conversion allocates on the heap and moves t
from the stack into it.
let x = 5;
let rc = Rc::new(5);
assert_eq!(Rc::from(x), rc);
1.21.0 · Source§ Source§
Allocates a reference-counted slice and moves v
âs items into it.
let unique: Vec<i32> = vec![1, 2, 3];
let shared: Rc<[i32]> = Rc::from(unique);
assert_eq!(&[1, 2, 3], &shared[..]);
1.37.0 · Source§ Source§
Takes each element in the Iterator
and collects it into an Rc<[T]>
.
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();
this behaves as if we wrote:
let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
.collect::<Vec<_>>() .into();
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]>
.
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();
1.0.0 · Source§ 1.0.0 · Source§ Source§
Comparison for two Rc
s.
The two are compared by calling cmp()
on their inner values.
use std::rc::Rc;
use std::cmp::Ordering;
let five = Rc::new(5);
assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));
1.21.0 · Source§
Compares and returns the maximum of two values.
Read more 1.21.0 · Source§Compares and returns the minimum of two values.
Read more 1.50.0 · Source§Restrict a value to a certain interval.
Read more 1.0.0 · Source§ Source§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.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five == Rc::new(5));
Source§
Inequality for two Rc
s.
Two Rc
s are not equal if their inner values are not equal.
If T
also implements Eq
(implying reflexivity of equality), two Rc
s that point to the same allocation are always equal.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five != Rc::new(6));
1.0.0 · Source§ Source§
Partial comparison for two Rc
s.
The two are compared by calling partial_cmp()
on their inner values.
use std::rc::Rc;
use std::cmp::Ordering;
let five = Rc::new(5);
assert_eq!(Some(Ordering::Less), five.partial_cmp(&Rc::new(6)));
Source§
Less-than comparison for two Rc
s.
The two are compared by calling <
on their inner values.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five < Rc::new(6));
Source§
âLess than or equal toâ comparison for two Rc
s.
The two are compared by calling <=
on their inner values.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five <= Rc::new(5));
Source§
Greater-than comparison for two Rc
s.
The two are compared by calling >
on their inner values.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five > Rc::new(4));
Source§
âGreater than or equal toâ comparison for two Rc
s.
The two are compared by calling >=
on their inner values.
use std::rc::Rc;
let five = Rc::new(5);
assert!(five >= Rc::new(5));
1.0.0 · Source§ 1.43.0 · Source§ Source§
The type returned in the event of a conversion error.
Source§Performs the conversion.
Source§ Source§ Source§ 1.0.0 · Source§ Source§ 1.58.0 · Source§ 1.0.0 · Source§ 1.0.0 · Source§ 1.33.0 · Source§ 1.9.0 · Source§ Source§RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4