Struct rs_ecs::Resources

pub struct Resources(_);

A type map for holding resources.

Resources replace global variables and my be accessed by systems that know their type.

Examples

struct WrapperType(u32);

let mut resources = Resources::new();

// Insert multiple resources
resources.insert(42_u32);
resources.insert(WrapperType(23));

// Borrow a resource immutably
let wrapped_res = resources.get::<WrapperType>();

// Borrow a resource mutably
let mut u32_res = resources.get_mut::<u32>();
*u32_res += 1;

Implementations

impl Resources

pub fn new() -> Self

Create an empty resources map.

impl Resources

pub fn insert<R>(&mut self, res: R) where
    R: 'static, 

Insert a resource.

Panics

Panics if a resource of the same type is already present.

pub fn clear(&mut self)

Drop all resources.

impl Resources

pub fn get<R>(&self) -> Res<'_, R> where
    R: 'static, 

Borrow a resource immutably

Panics

Panics if the resource is not present.

pub fn get_mut<R>(&self) -> ResMut<'_, R> where
    R: 'static, 

Borrow a resource mutably

Panics

Panics if the resource is not present.

Trait Implementations

impl Default for Resources

fn default() -> Self

Create an empty resources map.