[−][src]Struct oxygengine_core::ecs::Resources
A resource container, which provides methods to access to the contained resources.
Resource Ids
Resources are identified by ResourceId
s, which consist of a TypeId
.
Methods
impl Resources
[src]
pub fn new() -> Resources
[src]
Creates a new, empty resource container.
pub fn insert<R>(&mut self, r: R) where
R: Resource,
[src]
R: Resource,
Inserts a resource into this container. If the resource existed before, it will be overwritten.
Examples
Every type satisfying Any + Debug + Send + Sync
automatically implements Resource
,
thus can be added:
#[derive(Debug)] struct MyRes(i32);
When you have a resource, simply insert it like this:
use shred::Resources; let mut res = Resources::new(); res.insert(MyRes(5));
pub fn has_value<R>(&self) -> bool where
R: Resource,
[src]
R: Resource,
Returns true if the specified resource type R
exists in self
.
pub fn has_value_raw(&self, id: ResourceId) -> bool
[src]
Returns true if the specified resource type exists in self
.
pub fn entry<R>(&mut self) -> Entry<R> where
R: Resource,
[src]
R: Resource,
Returns an entry for the resource with type R
.
pub fn fetch<T>(&self) -> Fetch<T> where
T: Resource,
[src]
T: Resource,
Fetches the resource with the specified type T
or panics if it doesn't exist.
Panics
Panics if the resource doesn't exist. Panics if the resource is being accessed mutably.
pub fn try_fetch<T>(&self) -> Option<Fetch<T>> where
T: Resource,
[src]
T: Resource,
Like fetch
, but returns an Option
instead of inserting a default value
in case the resource does not exist.
pub fn fetch_mut<T>(&self) -> FetchMut<T> where
T: Resource,
[src]
T: Resource,
Fetches the resource with the specified type T
mutably.
Please see fetch
for details.
Panics
Panics if the resource doesn't exist. Panics if the resource is already being accessed.
pub fn try_fetch_mut<T>(&self) -> Option<FetchMut<T>> where
T: Resource,
[src]
T: Resource,
Like fetch_mut
, but returns an Option
instead of inserting a default value
in case the resource does not exist.
pub fn try_fetch_internal(
&self,
id: TypeId
) -> Option<&TrustCell<Box<dyn Resource + 'static>>>
[src]
&self,
id: TypeId
) -> Option<&TrustCell<Box<dyn Resource + 'static>>>
Internal function for fetching resources, should only be used if you know what you're doing.
pub fn get_mut<T>(&mut self) -> Option<&mut T> where
T: Resource,
[src]
T: Resource,
Retrieves a resource without fetching, which is cheaper, but only available with
&mut self
.
pub fn get_mut_raw(
&mut self,
id: TypeId
) -> Option<&mut (dyn Resource + 'static)>
[src]
&mut self,
id: TypeId
) -> Option<&mut (dyn Resource + 'static)>
Retrieves a resource without fetching, which is cheaper, but only available with
&mut self
.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Resources
impl Send for Resources
impl Sync for Resources
impl Unpin for Resources
impl !UnwindSafe for Resources
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Any for T where
T: Any,
T: Any,
fn get_type_id(&self) -> TypeId
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Erased for T
impl<T> Event for T where
T: Send + Sync + 'static,
[src]
T: Send + Sync + 'static,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Resource for T where
T: Any + Send + Sync,
[src]
T: Any + Send + Sync,
impl<T> TryDefault for T where
T: Default,
[src]
T: Default,
fn try_default() -> Result<T, String>
[src]
fn unwrap_default() -> Self
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,