Struct specs::saveload::UuidMarker

pub struct UuidMarker { /* private fields */ }

Basic marker uuid implementation usable for saving and loading.

Implementations

impl UuidMarker

pub fn new(uuid: Uuid) -> Self

Creates a new UuidMarker Component from the specified uuid.

pub fn new_random() -> Self

Creates a new UuidMarker Component with a random uuid.

pub fn uuid(&self) -> Uuid

Get the current uuid.

Trait Implementations

impl Clone for UuidMarker

fn clone(&self) -> UuidMarker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for UuidMarker

type Storage = VecStorage<UuidMarker>

Associated storage type for this component.

impl Debug for UuidMarker

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UuidMarker

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for UuidMarker

fn hash<__H: Hasher>(&self, state: &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 Marker for UuidMarker

type Allocator = UuidMarkerAllocator

Allocator for this Marker

type Identifier = Uuid

Id of the marker

fn id(&self) -> Uuid

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 DeserializeComponents. It can be used to update internal data that is not used for identification.

impl MarkerAllocator<UuidMarker> for UuidMarkerAllocator

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

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: Uuid) -> 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<'_, UuidMarker>
)

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.

impl PartialEq<UuidMarker> for UuidMarker

fn eq(&self, other: &UuidMarker) -> bool

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

fn ne(&self, other: &UuidMarker) -> bool

This method tests for !=.

impl Serialize for UuidMarker

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for UuidMarker

impl StructuralEq for UuidMarker

impl StructuralPartialEq for UuidMarker