Struct resources::Resources

pub struct Resources { /* fields omitted */ }

A Resource container, for storing at most one resource of each specific type.

Internally, this is a FxHashMap of TypeId to RwLock.

The lock is used in a non-blocking way; in fact, it's underlying implementation will panic instead of blocking.

Methods

impl Resources

pub fn new() -> Self

Creates an empty container. Functionally identical to default.

pub fn contains<T: Resource>(&self) -> bool

Returns true if a resource of type T exists in the container.

pub fn insert<T: Resource>(&mut self, resource: T) -> Option<T>

Inserts the given resource of type T into the container.

If a resource of this type was already present, it will be updated, and the original returned.

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

Removes the resource of type T from the container.

If a resource of this type was present in the container, it will be returned.

pub fn entry<T: Resource>(&mut self) -> Entry<T>

Gets the type T's corresponding entry for in-place manipulation.

pub fn get<T: Resource>(&self) -> Result<Ref<T>, CantGetResource>

Returns a reference to the stored resource of type T.

If such a resource is currently accessed mutably elsewhere, or is not present in the container, returns the appropriate error.

pub fn get_mut<T: Resource>(&self) -> Result<RefMut<T>, CantGetResource>

Returns a mutable reference to the stored resource of type T.

If such a resource is currently accessed immutably or mutably elsewhere, or is not present in the container, returns the appropriate error.

Trait Implementations

impl Default for Resources

fn default() -> Resources

Returns the "default value" for a type.