Struct bones_ecs::resources::AtomicResource

pub struct AtomicResource<T: HasSchema> { /* private fields */ }

A handle to a resource from a Resources collection.

This is not the resource itself, but a cheaply clonable handle to it.

To access the resource you must borrow it with either borrow() or borrow_mut().

Implementations

impl<T: HasSchema> AtomicResource<T>

pub fn empty() -> Self

Create a new, empty resource cell.

pub fn new(data: T) -> Self

Create a new resource cell with the given data.

pub fn from_untyped( untyped: AtomicUntypedResource, ) -> Result<Self, SchemaMismatchError>

Create from an UntypedResource.

pub fn remove(&self) -> Option<T>

Remove the resource from the cell, leaving the cell empty.

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

Lock the resource for reading.

This returns a read guard, very similar to an RwLock.

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

Lock the resource for read-writing.

This returns a write guard, very similar to an RwLock.

pub fn into_untyped(self) -> AtomicUntypedResource

Convert into an untyped resource.

impl<T: HasSchema + FromWorld> AtomicResource<T>

pub fn init(&self, world: &World)

Initialize the resource using it’s FromWorld implementation, if it is not present.

pub fn init_borrow(&self, world: &World) -> Ref<'_, T>

Borrow the resource, initializing it if it doesn’t exist.

pub fn init_borrow_mut(&self, world: &World) -> RefMut<'_, T>

Borrow the resource, initializing it if it doesn’t exist.

Trait Implementations

impl<T: Clone + HasSchema> Clone for AtomicResource<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: HasSchema + Debug> Debug for AtomicResource<T>

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

Formats the value using the given formatter.

impl<T: HasSchema + Default> Default for AtomicResource<T>

fn default() -> Self

Returns the “default value” for a type.