Struct oxygengine_core::ecs::shred::cell::TrustCell

pub struct TrustCell<T> { /* fields omitted */ }

A custom cell container that is a RefCell with thread-safety.

Implementations

impl<T> TrustCell<T>

pub fn new(val: T) -> TrustCell<T>

Create a new cell, similar to RefCell::new

pub fn into_inner(self) -> T

Consumes this cell and returns ownership of T.

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

Get an immutable reference to the inner data.

Absence of write accesses is checked at run-time.

Panics

This function will panic if there is a mutable reference to the data already in use.

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

Get an immutable reference to the inner data.

Absence of write accesses is checked at run-time. If access is not possible, an error is returned.

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

Get a mutable reference to the inner data.

Exclusive access is checked at run-time.

Panics

This function will panic if there are any references to the data already in use.

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

Get a mutable reference to the inner data.

Exclusive access is checked at run-time. If access is not possible, an error is returned.

pub fn get_mut(&mut self) -> &mut T

Gets exclusive access to the inner value, bypassing the Cell.

Exclusive access is checked at compile time.

Trait Implementations

impl<T> Debug for TrustCell<T> where
    T: Debug, 

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> Default for TrustCell<T> where
    T: Default, 

pub fn default() -> TrustCell<T>

Returns the “default value” for a type.

impl<T> Sync for TrustCell<T> where
    T: Sync,