Resources

Struct Resources 

Source
pub struct Resources { /* private fields */ }
Expand description

A collection of resources.

Resources is essentially a type-map

Implementations§

Source§

impl Resources

Source

pub fn new() -> Resources

Create an empty Resources.

Source

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.

Source

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.

Source

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.

Source

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

Check whether or not a resource is in the store.

See get()

Source

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

Gets a resource handle from the store if it exists.

Source

pub fn untyped(&self) -> &UntypedResources

Borrow the underlying UntypedResources store.

Source

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

Mutably borrow the underlying UntypedResources store.

Source

pub fn into_untyped(self) -> UntypedResources

Consume Resources and extract the underlying UntypedResources.

Trait Implementations§

Source§

impl Clone for Resources

Source§

fn clone(&self) -> Resources

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for Resources

Source§

fn default() -> Resources

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> RawFns for T
where T: Clone,

Source§

unsafe extern "C" fn raw_drop(ptr: *mut u8)

Drop the value at ptr. Read more
Source§

unsafe extern "C" fn raw_clone(src: *const u8, dst: *mut u8)

Clone the value at src, writing the new value to dst. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> EcsData for T
where T: Clone + Sync + Send + 'static,