Struct amethyst::ecs::shred::cell::TrustCell

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

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

Methods

impl<T> TrustCell<T>

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

Create a new cell, similar to RefCell::new

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.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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> Default for TrustCell<T> where     T: Default,

fn default() -> TrustCell<T>

Returns the "default value" for a type.

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

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

Formats the value using the given formatter.

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