Struct glsp_engine::RRoot

pub struct RRoot<T: RStore>(_, _);

A strongly-typed reference to an RData.

Equivalent to a Root<RData>, but it enforces that the RData must contain a value of type T.

RRoot tends to be more self-documenting than Root<RData>, and it has a slightly more convenient API.

//using Root
let mesh = player_mesh.borrow::<Mesh>();
let mesh2 = enemy_mesh.take::<Mesh>();

//using RRoot
let mesh = player_mesh.borrow();
let mesh2 = enemy_mesh.take();

Implementations

impl<T: RStore> RRoot<T>

pub fn new(root: Root<RData>) -> RRoot<T>

Constructs an RRoot<T> from a Root<RData>.

Panics if the RData's value does not belong to the type T.

pub fn to_root(&self) -> Root<RData>

Returns a copy of the underlying Root<RData>.

pub fn into_root(self) -> Root<RData>

Drops the RRoot, returning the wrapped Root<RData>.

pub fn ptr_eq(rr0: &RRoot<T>, rr1: &RRoot<T>) -> bool

Returns true if both RRoots refer to the same RData.

pub fn borrow(&self) -> RRef<T>

Equivalent to RData::borrow.

pub fn borrow_mut(&self) -> RRefMut<T>

Equivalent to RData::borrow_mut.

pub fn try_borrow(&self) -> GResult<RRef<T>>

Equivalent to RData::try_borrow.

pub fn try_borrow_mut(&self) -> GResult<RRefMut<T>>

Equivalent to RData::try_borrow_mut.

pub fn take(&self) -> GResult<T>

Equivalent to RData::take.

pub fn free(&self) -> GResult<()>

Equivalent to RData::free.

pub fn is_freed(&self) -> bool

Equivalent to RData::is_freed.

Trait Implementations

impl<T: RStore> Clone for RRoot<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: RStore> Debug for RRoot<T>

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

Formats the value using the given formatter.

impl<T: RStore> Display for RRoot<T>

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

Formats the value using the given formatter.

impl<T: RStore> FromVal for RRoot<T>

fn from_val(val: &Val) -> GResult<RRoot<T>>

fn from_slot(slot: &Slot) -> GResult<RRoot<T>>

impl<T: RStore> Pointer for RRoot<T>

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

Formats the value using the given formatter.

impl<T: RStore> ToVal for RRoot<T>

fn to_val(&self) -> GResult<Val>

fn to_slot(&self) -> GResult<Slot>