[−][src]Struct gc::GcCell
A mutable memory location with dynamically checked borrow rules that can be used inside of a garbage-collected pointer.
This object is a RefCell
that can be used inside of a Gc<T>
.
Methods
impl<T: Trace> GcCell<T>
[src]
pub fn new(value: T) -> Self
[src]
Creates a new GcCell
containing value
.
pub fn into_inner(self) -> T
[src]
Consumes the GcCell
, returning the wrapped value.
impl<T: Trace + ?Sized> GcCell<T>
[src]
pub fn borrow(&self) -> GcCellRef<T>
[src]
Immutably borrows the wrapped value.
The borrow lasts until the returned GcCellRef
exits scope.
Multiple immutable borrows can be taken out at the same time.
Panics
Panics if the value is currently mutably borrowed.
pub fn borrow_mut(&self) -> GcCellRefMut<T>
[src]
Mutably borrows the wrapped value.
The borrow lasts until the returned GcCellRefMut
exits scope.
The value cannot be borrowed while this borrow is active.
Panics
Panics if the value is currently borrowed.
pub fn try_borrow(&self) -> Result<GcCellRef<T>, BorrowError>
[src]
Immutably borrows the wrapped value, returning an error if the value is currently mutably borrowed.
The borrow lasts until the returned GcCellRef
exits scope. Multiple immutable borrows can be
taken out at the same time.
This is the non-panicking variant of borrow
.
Examples
use gc::GcCell; let c = GcCell::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 try_borrow_mut(&self) -> Result<GcCellRefMut<T>, BorrowMutError>
[src]
Mutably borrows the wrapped value, returning an error if the value is currently borrowed.
The borrow lasts until the returned GcCellRefMut
exits scope.
The value cannot be borrowed while this borrow is active.
This is the non-panicking variant of borrow_mut
.
Examples
use gc::GcCell; let c = GcCell::new(5); { let m = c.borrow(); assert!(c.try_borrow_mut().is_err()); } assert!(c.try_borrow_mut().is_ok());
Trait Implementations
impl<T: Trace + Clone> Clone for GcCell<T>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Trace + ?Sized + Debug> Debug for GcCell<T>
[src]
impl<T: Trace + Default> Default for GcCell<T>
[src]
impl<T: Trace + ?Sized + Eq> Eq for GcCell<T>
[src]
impl<T: Trace + ?Sized> Finalize for GcCell<T>
[src]
impl<T: Trace + ?Sized + Ord> Ord for GcCell<T>
[src]
fn cmp(&self, other: &GcCell<T>) -> Ordering
[src]
#[must_use]fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]fn clamp(self, min: Self, max: Self) -> Self
[src]
impl<T: Trace + ?Sized + PartialEq> PartialEq<GcCell<T>> for GcCell<T>
[src]
impl<T: Trace + ?Sized + PartialOrd> PartialOrd<GcCell<T>> for GcCell<T>
[src]
fn partial_cmp(&self, other: &Self) -> Option<Ordering>
[src]
fn lt(&self, other: &Self) -> bool
[src]
fn le(&self, other: &Self) -> bool
[src]
fn gt(&self, other: &Self) -> bool
[src]
fn ge(&self, other: &Self) -> bool
[src]
impl<T: ?Sized + Send> Send for GcCell<T>
[src]
impl<T: Trace + ?Sized> Trace for GcCell<T>
[src]
Auto Trait Implementations
impl<T> !RefUnwindSafe for GcCell<T>
impl<T> !Sync for GcCell<T>
impl<T: ?Sized> Unpin for GcCell<T> where
T: Unpin,
T: Unpin,
impl<T: ?Sized> UnwindSafe for GcCell<T> where
T: UnwindSafe,
T: UnwindSafe,
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<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, 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>,