Struct rc::Rc
[−]
[src]
pub struct Rc<T> {
// some fields omitted
}A reference-counted pointer type over an immutable value.
See the module level documentation for more details.
Methods
impl<T> Rc<T>
fn new(value: T) -> Rc<T>
fn try_unwrap(rc: Rc<T>) -> Result<T, Rc<T>>
Unwraps the contained value if the Rc<T> is unique.
If the Rc<T> is not unique, an Err is returned with the same
Rc<T>.
Examples
use rc::Rc; let x = Rc::new(3); assert_eq!(Rc::try_unwrap(x), Ok(3)); let x = Rc::new(4); let _y = x.clone(); assert_eq!(Rc::try_unwrap(x), Err(Rc::new(4)));
impl<T> Rc<T>
fn downgrade(&self) -> Weak<T>
Downgrades the Rc<T> to a Weak<T> reference.
Examples
use rc::Rc; let five = Rc::new(5); let weak_five = five.downgrade();
fn weak_count(this: &Rc<T>) -> usize
Get the number of weak references to this value.
fn strong_count(this: &Rc<T>) -> usize
Get the number of strong references to this value.
fn is_unique(rc: &Rc<T>) -> bool
Returns true if there are no other Rc or Weak<T> values that share
the same inner value.
Examples
use rc::Rc; let five = Rc::new(5); assert!(Rc::is_unique(&five));
fn get_mut(rc: &mut Rc<T>) -> Option<&mut T>
Returns a mutable reference to the contained value if the Rc<T> is
unique.
Returns None if the Rc<T> is not unique.
Examples
use rc::Rc; let mut x = Rc::new(3); *Rc::get_mut(&mut x).unwrap() = 4; assert_eq!(*x, 4); let _y = x.clone(); assert!(Rc::get_mut(&mut x).is_none());
impl<T: Clone> Rc<T>
fn make_unique(&mut self) -> &mut T
Make a mutable reference from the given Rc<T>.
This is also referred to as a copy-on-write operation because the inner data is cloned if the reference count is greater than one.
Examples
use rc::Rc; let mut five = Rc::new(5); let mut_five = five.make_unique();