Struct bones_render::prelude::Resources

pub struct Resources { /* private fields */ }

A collection of resources.

Resources is essentially a type-map

Implementations

impl Resources

pub fn new() -> Resources

Create an empty Resources.

pub fn init<T>(&mut self)where
    T: TypedEcsData + Default,

Initialize a resource of type T by inserting it’s default value.

pub fn insert<T>(&mut self, resource: T)where
    T: TypedEcsData,

Insert a resource.

Panics

Panics if you try to insert a Rust type with a different TypeId, but the same TypeUlid as another resource in the store.

pub fn try_insert<T>(&mut self, resource: T) -> Result<(), EcsError>where
    T: TypedEcsData,

Try to insert a resource.

Errors

Errors if you try to insert a Rust type with a different TypeId, but the same TypeUlid as another resource in the store.

pub fn get<T>(&self) -> AtomicResource<T>where
    T: TypedEcsData,

Get a resource handle from the store.

This is not the resource itself, but a handle, may be cloned cheaply.

In order to access the resource you must call borrow() or borrow_mut() on the returned value.

Panics

Panics if the resource does not exist in the store.

pub fn contains<T>(&self) -> boolwhere
    T: TypedEcsData,

Check whether or not a resource is in the store.

See get()

pub fn try_get<T>(&self) -> Option<AtomicResource<T>>where
    T: TypedEcsData,

Gets a resource handle from the store if it exists.

pub fn untyped(&self) -> &UntypedResources

Borrow the underlying UntypedResources store.

pub fn untyped_mut(&mut self) -> &mut UntypedResources

Mutably borrow the underlying UntypedResources store.

pub fn into_untyped(self) -> UntypedResources

Consume Resources and extract the underlying UntypedResources.

Trait Implementations

impl Clone for Resources

fn clone(&self) -> Resources

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Resources

fn default() -> Resources

Returns the “default value” for a type.