[−][src]Struct rc_cell::RcCell
The main attraction. Equivalent to Rc<RefCell<T>>
but with one fewer type. Rc
methods are
reimplemented, and RefCell
methods are gained by its Deref
implementation.
All undocumented methods are equivalent to the Rc
function of identical name.
Methods
impl<T> RcCell<T>
[src]
pub fn new(value: T) -> Self
[src]
pub fn try_unwrap(this: Self) -> Result<T, Self>
[src]
pub fn downgrade(&self) -> RcCellWeak<T>
[src]
pub fn weak_count(&self) -> usize
[src]
pub fn strong_count(&self) -> usize
[src]
pub fn ptr_eq(&self, other: &Self) -> bool
[src]
pub fn swap_with(&self, other: &Self)
[src]
Like swap
, but with another RcCell
instead of a RefCell
.
Methods from Deref<Target = RefCell<T>>
pub fn replace(&self, t: T) -> T
1.24.0[src]
Replaces the wrapped value with a new one, returning the old value, without deinitializing either one.
This function corresponds to std::mem::replace
.
Panics
Panics if the value is currently borrowed.
Examples
use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace(6); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn replace_with<F>(&self, f: F) -> T where
F: FnOnce(&mut T) -> T,
1.35.0[src]
F: FnOnce(&mut T) -> T,
Replaces the wrapped value with a new one computed from f
, returning
the old value, without deinitializing either one.
Panics
Panics if the value is currently borrowed.
Examples
use std::cell::RefCell; let cell = RefCell::new(5); let old_value = cell.replace_with(|&mut old| old + 1); assert_eq!(old_value, 5); assert_eq!(cell, RefCell::new(6));
pub fn swap(&self, other: &RefCell<T>)
1.24.0[src]
Swaps the wrapped value of self
with the wrapped value of other
,
without deinitializing either one.
This function corresponds to std::mem::swap
.
Panics
Panics if the value in either RefCell
is currently borrowed.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let d = RefCell::new(6); c.swap(&d); assert_eq!(c, RefCell::new(6)); assert_eq!(d, RefCell::new(5));
pub fn borrow(&self) -> Ref<T>
1.0.0[src]
Immutably borrows the wrapped value.
The borrow lasts until the returned Ref
exits scope. Multiple
immutable borrows can be taken out at the same time.
Panics
Panics if the value is currently mutably borrowed. For a non-panicking variant, use
try_borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let borrowed_five = c.borrow(); let borrowed_five2 = c.borrow();
An example of panic:
use std::cell::RefCell; use std::thread; let result = thread::spawn(move || { let c = RefCell::new(5); let m = c.borrow_mut(); let b = c.borrow(); // this causes a panic }).join(); assert!(result.is_err());
pub fn try_borrow(&self) -> Result<Ref<T>, BorrowError>
1.13.0[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
The borrow lasts until the returned Ref
exits scope. Multiple immutable borrows can be
taken out at the same time.
This is the non-panicking variant of borrow
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow_mut(); assert!(c.try_borrow().is_err()); } { let m = c.borrow(); assert!(c.try_borrow().is_ok()); }
pub fn borrow_mut(&self) -> RefMut<T>
1.0.0[src]
Mutably borrows the wrapped value.
The borrow lasts until the returned RefMut
or all RefMut
s derived
from it exit scope. The value cannot be borrowed while this borrow is
active.
Panics
Panics if the value is currently borrowed. For a non-panicking variant, use
try_borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); *c.borrow_mut() = 7; assert_eq!(*c.borrow(), 7);
An example of panic:
use std::cell::RefCell; use std::thread; let result = thread::spawn(move || { let c = RefCell::new(5); let m = c.borrow(); let b = c.borrow_mut(); // this causes a panic }).join(); assert!(result.is_err());
pub fn try_borrow_mut(&self) -> Result<RefMut<T>, BorrowMutError>
1.13.0[src]
Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
The borrow lasts until the returned RefMut
or all RefMut
s derived
from it exit scope. The value cannot be borrowed while this borrow is
active.
This is the non-panicking variant of borrow_mut
.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow(); assert!(c.try_borrow_mut().is_err()); } assert!(c.try_borrow_mut().is_ok());
pub fn as_ptr(&self) -> *mut T
1.12.0[src]
Returns a raw pointer to the underlying data in this cell.
Examples
use std::cell::RefCell; let c = RefCell::new(5); let ptr = c.as_ptr();
pub unsafe fn try_borrow_unguarded(&self) -> Result<&T, BorrowError>
1.37.0[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
Safety
Unlike RefCell::borrow
, this method is unsafe because it does not
return a Ref
, thus leaving the borrow flag untouched. Mutably
borrowing the RefCell
while the reference returned by this method
is alive is undefined behaviour.
Examples
use std::cell::RefCell; let c = RefCell::new(5); { let m = c.borrow_mut(); assert!(unsafe { c.try_borrow_unguarded() }.is_err()); } { let m = c.borrow(); assert!(unsafe { c.try_borrow_unguarded() }.is_ok()); }
Trait Implementations
impl<T: Clone> Clone for RcCell<T>
[src]
impl<T: Debug> Debug for RcCell<T>
[src]
impl<T: Default> Default for RcCell<T>
[src]
impl<T> Deref for RcCell<T>
[src]
type Target = RefCell<T>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
impl<T> Display for RcCell<T> where
T: Display,
[src]
T: Display,
impl<T: Eq> Eq for RcCell<T>
[src]
impl<T> From<Box<T>> for RcCell<T>
[src]
impl<T> From<T> for RcCell<T>
[src]
impl<T: Ord> Ord for RcCell<T>
[src]
fn cmp(&self, other: &RcCell<T>) -> Ordering
[src]
fn max(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
1.21.0[src]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T: PartialEq> PartialEq<RcCell<T>> for RcCell<T>
[src]
impl<T: PartialOrd> PartialOrd<RcCell<T>> for RcCell<T>
[src]
fn partial_cmp(&self, other: &RcCell<T>) -> Option<Ordering>
[src]
fn lt(&self, other: &RcCell<T>) -> bool
[src]
fn le(&self, other: &RcCell<T>) -> bool
[src]
fn gt(&self, other: &RcCell<T>) -> bool
[src]
fn ge(&self, other: &RcCell<T>) -> bool
[src]
impl<T> Pointer for RcCell<T>
[src]
impl<T> StructuralEq for RcCell<T>
[src]
impl<T> StructuralPartialEq for RcCell<T>
[src]
Auto Trait Implementations
impl<T> !RefUnwindSafe for RcCell<T>
impl<T> !Send for RcCell<T>
impl<T> !Sync for RcCell<T>
impl<T> Unpin for RcCell<T>
impl<T> !UnwindSafe for RcCell<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<!> for T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,