Struct specs::saveload::U64MarkerAllocator

pub struct U64MarkerAllocator { /* fields omitted */ }

Basic marker allocator

Methods

impl U64MarkerAllocator

pub fn new() -> Self

Create new U64MarkerAllocator which will yield U64Markers starting with 0

Trait Implementations

impl Clone for U64MarkerAllocator

fn clone(&self) -> U64MarkerAllocator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for U64MarkerAllocator

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for U64MarkerAllocator

fn default() -> Self

Returns the "default value" for a type.

impl MarkerAllocator<U64Marker> for U64MarkerAllocator

fn allocate(&mut self, entity: Entity, id: Option<u64>) -> U64Marker

Allocates a new marker for a given entity. If you don't pass an id, a new unique id will be created.

fn retrieve_entity_internal(&self, id: u64) -> Option<Entity>

Get an Entity by a marker identifier. This function only accepts an id; it does not update the marker data.

fn maintain(&mut self, entities: &EntitiesRes, storage: &ReadStorage<U64Marker>)

Maintain internal data. Cleanup if necessary.

fn retrieve_entity(
    &mut self,
    marker: M,
    storage: &mut WriteStorage<M>,
    entities: &EntitiesRes
) -> Entity

Tries to retrieve an entity by the id of the marker; if no entity has a marker with the same id, a new entity will be created and marker will be inserted for it.

fn mark<'m>(
    &mut self,
    entity: Entity,
    storage: &'m mut WriteStorage<M>
) -> Option<(&'m M, bool)>

Create new unique marker M and attach it to entity. Or get old marker if this entity is already marked. If entity is dead then this will return None.