Struct rafx_base::resource_map::ResourceMap

pub struct ResourceMap { /* fields omitted */ }

A key-value structure. The key is a type, and the value is a single object of that type

Implementations

impl ResourceMap

pub fn new() -> Self

Creates an empty resource map

pub fn try_insert_default<R>(&mut self) where
    R: Resource + Default, 

pub fn insert<R>(&mut self, r: R) where
    R: Resource, 

Add a type/resource instance to the map

pub fn remove<R>(&mut self) -> Option<R> where
    R: Resource, 

Remove a type/resource instance from the map

pub fn fetch<R: Resource>(&self) -> ReadBorrow<'_, R>

Read-only fetch of a resource. Trying to get a resource that is not in the map is fatal. Use try_fetch if unsure whether the resource exists. Requesting read access to a resource that has any concurrently active writer is fatal.

pub fn try_fetch<R: Resource>(&self) -> Option<ReadBorrow<'_, R>>

Read-only fetch of a resource. Requesting read access to a resource that has a concurrently active writer is fatal. Returns None if the type is not registered.

pub fn fetch_mut<R: Resource>(&self) -> WriteBorrow<'_, R>

Read/Write fetch of a resource. Trying to get a resource that is not in the map is fatal. Use try_fetch if unsure whether the resource exists. Requesting write access to a resource with any concurrently active read/write is fatal

pub fn try_fetch_mut<R: Resource>(&self) -> Option<WriteBorrow<'_, R>>

Read/Write fetch of a resource. Requesting write access to a resource with any concurrently active read/write is fatal. Returns None if the type is not registered.

pub fn has_value<R>(&self) -> bool where
    R: Resource, 

Returns true if the resource is registered.

pub fn keys(&self) -> impl Iterator<Item = &ResourceId>

Iterate all ResourceIds within the dictionary

Trait Implementations

impl Default for ResourceMap

fn default() -> ResourceMap

Returns the “default value” for a type.