Struct Registry 

pub struct Registry<ID: Hash + Eq, T> { /* private fields */ }

A registry is just like a map but supposed to be used with an enum of IDs. It panics in many cases to make sure items are created and deleted in a planned manner. You can also think of it as a cache.

Use-cases: Registering and caching bindgroups, shaders, audio, etc..

The user is heavily adviced to do something like:

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
enum ExampleId {
    A,
    B,
    C,
}
type ExampleRegistry = Registry<ExampleId, BindGroup>;

Implementations

impl<ID: Hash + Eq, T> Registry<ID, T>

pub fn new() -> Self

pub fn insert(&mut self, id: ID, item: T)

Panics if the item already exists.

pub fn overwrite(&mut self, id: ID, item: T)

Panics if the item does not yet exist.

pub fn insert_or_overwrite(&mut self, id: ID, item: T)

Does not panic.

pub fn remove(&mut self, id: &ID) -> T

Panics if the item does not exist.

pub fn try_remove(&mut self, id: &ID) -> Option<T>

Does not panic.

pub fn get(&self, id: &ID) -> &T

Panics if the item does not exist.

pub fn try_get(&self, id: &ID) -> Option<&T>

Does not panic.

pub fn exists(&self, id: &ID) -> bool

Does not panic

Trait Implementations

impl<ID: Hash + Eq, T> Default for Registry<ID, T>

fn default() -> Self

Returns the “default value” for a type.