Struct rinecs::ResourcesCreation

pub struct ResourcesCreation<'a> { /* fields omitted */ }

Gives access to the world global Send and thread local resources for reading and writing

Resources are useful for certain data that needs to be accessed from several systems but doesn’t belong to any specific entity

It’s similar to a singleton in that it can be accessed from any system and there’s only one instance per type

Implementations

impl<'a> ResourcesCreation<'a>

pub fn get<T: 'static>(&self) -> Option<ReadGuardRef<'_, T>>

pub fn get_mut<T: 'static>(&self) -> Option<WriteGuardRef<'_, T>>

pub fn as_trait<T: 'static + ?Sized>(&self) -> Option<ReadGuardRef<'_, T>>

pub fn as_trait_mut<T: 'static + ?Sized>(&self) -> Option<WriteGuardRef<'_, T>>

pub fn to_send(&mut self) -> Resources<'_>

pub fn to_thread_local(&mut self) -> ResourcesThreadLocal<'_>

pub fn add<T: 'static + Send>(&mut self, resource: T)

Adds a Send resource to the world.

Resources are globally accesible by any system through the Resources object passed as parameter to them.

pub fn add_thread_local<T: 'static>(&mut self, resource: T)

Adds a non Send resource to the world.

Non Send resources are globally accesible by any SystemThreadLocal through the ResourcesThreadLocal object passed as parameter to them.

pub fn add_as_trait<T, U: ?Sized, F, FMut>(&mut self, resource: (T, F, FMut)) where
    T: 'static + Send,
    U: 'static + Send,
    F: Fn(&T) -> &U + 'static,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a Send resource to the world accessible as a &dyn Trait.

Resources are globally accesible by any system through the Resources object passed as parameter to them.

pub fn add_as_trait_thread_local<T, U: ?Sized, F, FMut>(
    &mut self,
    resource: (T, F, FMut)
) where
    T: 'static,
    U: 'static,
    F: Fn(&T) -> &U + 'static,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a non Send resource to the world accessible as a &dyn Trait.

Resources are globally accesible by any system through the Resources object passed as parameter to them.

pub fn remove<T: 'static>(&mut self) -> Option<T>

Removes a resource of the specified type.

pub fn clone(&mut self) -> ResourcesCreation<'_>

Trait Implementations

impl<'a> ResourcesCreationExt for ResourcesCreation<'a>

fn with_resources_creation<F, R>(&mut self, f: F) -> R where
    F: FnOnce(ResourcesCreation<'_>) -> R, 

fn add_resource<T: 'static + Send>(&mut self, resource: T)

Adds a Send resource to the world.

fn remove_resource<T: 'static>(&mut self) -> Option<T>

Removes a resource of the specified type.

fn add_resource_thread_local<T: 'static>(&mut self, resource: T)

Adds a non Send resource to the world.

fn add_resource_as_trait<T, U: ?Sized, F, FMut>(
    &mut self,
    resource: (T, F, FMut)
) where
    T: 'static + Send,
    U: 'static + Send,
    F: Fn(&T) -> &U + 'static,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a Send resource to the world accessible as a &dyn Trait.

fn add_resource_as_trait_thread_local<T, U: ?Sized, F, FMut>(
    &mut self,
    resource: (T, F, FMut)
) where
    T: 'static,
    U: 'static,
    F: Fn(&T) -> &U + 'static,
    FMut: Fn(&mut T) -> &mut U + 'static, 

Adds a non Send resource to the world accessible as a &dyn Trait.

impl<'a> ResourcesExt for ResourcesCreation<'a>

fn resource<T: 'static + Send>(&self) -> Option<ReadGuardRef<'_, T>>

fn resource_mut<T: 'static + Send>(&self) -> Option<WriteGuardRef<'_, T>>

fn resource_as_trait<T: 'static + Send + ?Sized>(
    &self
) -> Option<ReadGuardRef<'_, T>>

fn resource_as_trait_mut<T: 'static + Send + ?Sized>(
    &self
) -> Option<WriteGuardRef<'_, T>>

impl<'a> ResourcesThreadLocalExt for ResourcesCreation<'a>

fn resource_thread_local<T: 'static>(&self) -> Option<ReadGuardRef<'_, T>>

fn resource_thread_local_mut<T: 'static>(&self) -> Option<WriteGuardRef<'_, T>>

fn resource_as_trait_thread_local<T: 'static + ?Sized>(
    &self
) -> Option<ReadGuardRef<'_, T>>

fn resource_as_trait_thread_local_mut<T: 'static + ?Sized>(
    &self
) -> Option<WriteGuardRef<'_, T>>