Struct Store

pub struct Store { /* private fields */ }

A karmeliet triple store.

Implementations

impl Store

pub fn entity(&mut self) -> Entity

Create a new entity.

pub fn insert<T: 'static>(&mut self, e: Entity, value: T) -> Option<T>

Attach an attribute of type T to the entity e.

If there already was an attribute of type T for that entity, the old value is returned, and the after_remove hook is run before inserting the new value.

pub fn remove<T: 'static>(&mut self, e: Entity) -> Option<T>

Remove the attribute of type T from the entity e.

If no attribute of that type exists on that entity, None is returned.

pub fn update<T: 'static, R>( &mut self, e: Entity, f: impl FnOnce(&mut T) -> R, ) -> Option<R>

Update the attribute of type T on the entity e with the given function.

If no attribute of that type exists on that entity, the function is not executed and None is returned.

If the attribute does exist, this will run both the after_remove and the before_insert hooks, with the previous and updated value respectively.

pub fn upsert<T: Default + 'static, R>( &mut self, e: Entity, f: impl FnOnce(&mut T) -> R, ) -> R

Update the attribute of type T on the entity e with the given function.

If no attribute of that type exists on that entity, a defaut value is first inserted.

Like update, this will run both after_remove and before_insert hooks, unless the attribute didn’t exist yet, in which case only the before_insert hook is run.

pub fn get<T: 'static>(&self, e: Entity) -> Option<&T>

Borrow the attribute of type T on the entity e.

If no attribute of that type exists on that entity, None is returned.

pub fn contains<T: 'static>(&self, e: Entity) -> bool

Check whether the entity e has an attribute of type T.

pub fn iter<T: 'static>(&self) -> AttrIter<'_, T>

Iterate over all entities with attribute of type T.

pub fn hook_before_insert<T, H>(&mut self, hook: H)

where T: 'static, H: Fn(&mut Store, Entity, &T) + 'static,

Set a hook that will be run before an attribute of type T is inserted.

The hook will also run after an attribute is updated with update and upsert.

pub fn hook_after_remove<T, H>(&mut self, hook: H)

where T: 'static, H: Fn(&mut Store, Entity, &T) + 'static,

Set a hook that will be run after an attribute of type T is removed.

The hook will also run before an attribute is updated with update and upsert.

Note that this hook is not run when the Store is dropped.

Trait Implementations

impl Default for Store

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Store

fn drop(&mut self)

Executes the destructor for this type.