Struct lucia_lang::gc::RefCell

pub struct RefCell<T: ?Sized> { /* private fields */ }

A mutable memory location with dynamically checked borrow rules.

Implementations

impl<T> RefCell<T>

pub const fn new(value: T) -> RefCell<T>

Creates a new RefCell containing value.

impl<T: ?Sized> RefCell<T>

pub fn borrow(&self) -> Ref<'_, T>

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.

pub fn try_borrow(&self) -> Result<Ref<'_, T>, BorrowError>

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.

pub fn borrow_mut(&self) -> RefMut<'_, T>

Mutably borrows the wrapped value.

The borrow lasts until the returned RefMut or all RefMuts 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.

pub fn try_borrow_mut(&self) -> Result<RefMut<'_, T>, BorrowMutError>

Mutably borrows the wrapped value, returning an error if the value is currently borrowed.

The borrow lasts until the returned RefMut or all RefMuts derived from it exit scope. The value cannot be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn as_ptr(&self) -> *mut T

Returns a raw pointer to the underlying data in this cell.

pub fn is_unused(&self) -> bool

Returns whether this cell is writing.

pub fn is_writing(&self) -> bool

Returns whether this cell is writing.

pub fn is_reading(&self) -> bool

Returns whether this cell is reading.

Trait Implementations

impl<T: Clone> Clone for RefCell<T>

fn clone(&self) -> RefCell<T>

Panics

Panics if the value is currently mutably borrowed.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: ?Sized + Ord> Ord for RefCell<T>

fn cmp(&self, other: &RefCell<T>) -> Ordering

Panics

Panics if the value in either RefCell is currently borrowed.

impl<T: ?Sized + PartialEq> PartialEq<RefCell<T>> for RefCell<T>

fn eq(&self, other: &RefCell<T>) -> bool

Panics

Panics if the value in either RefCell is currently borrowed.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized + PartialOrd> PartialOrd<RefCell<T>> for RefCell<T>

fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering>

Panics

Panics if the value in either RefCell is currently borrowed.

fn lt(&self, other: &RefCell<T>) -> bool

Panics

Panics if the value in either RefCell is currently borrowed.

fn le(&self, other: &RefCell<T>) -> bool

Panics

Panics if the value in either RefCell is currently borrowed.

fn gt(&self, other: &RefCell<T>) -> bool

Panics

Panics if the value in either RefCell is currently borrowed.

fn ge(&self, other: &RefCell<T>) -> bool

Panics

Panics if the value in either RefCell is currently borrowed.

impl<T: Trace> Trace for RefCell<T>

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn marked(&self) -> bool

Is this object marked.

impl<T: ?Sized + Eq> Eq for RefCell<T>