Struct specs::saveload::U64Marker

pub struct U64Marker(_);

Basic marker implementation usable for saving and loading

Trait Implementations

impl Clone for U64Marker

fn clone(&self) -> U64Marker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for U64Marker

impl Debug for U64Marker

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

Formats the value using the given formatter.

impl Hash for U64Marker

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq for U64Marker

fn eq(&self, __arg_0: &U64Marker) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &U64Marker) -> bool

This method tests for !=.

impl Eq for U64Marker

impl PartialOrd for U64Marker

fn partial_cmp(&self, __arg_0: &U64Marker) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, __arg_0: &U64Marker) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &U64Marker) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, __arg_0: &U64Marker) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &U64Marker) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Ord for U64Marker

fn cmp(&self, __arg_0: &U64Marker) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl Component for U64Marker

type Storage = DenseVecStorage<Self>

Associated storage type for this component.

impl Marker for U64Marker

type Allocator = U64MarkerAllocator

Allocator for this Marker

type Identifier = u64

Id of the marker

fn id(&self) -> u64

Get this marker internal id. The value of this method should be constant.

fn update(&mut self, new_revision: Self)

This gets called when an entity is deserialized by DeserializeEntity. It can be used to update internal data that is not used for identification.

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.