Struct SimpleMarker

pub struct SimpleMarker<T: ?Sized>(/* private fields */);

Basic marker implementation usable for saving and loading, uses u64 as identifier

Trait Implementations

impl<T: ?Sized> Clone for SimpleMarker<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Component for SimpleMarker<T>

where T: 'static + ?Sized + Send + Sync,

type Storage = DenseVecStorage<SimpleMarker<T>>

Associated storage type for this component.

impl<T: ?Sized> Debug for SimpleMarker<T>

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

Formats the value using the given formatter.

impl<'de, T: ?Sized> Deserialize<'de> for SimpleMarker<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: ?Sized> Hash for SimpleMarker<T>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Marker for SimpleMarker<T>

where T: 'static + ?Sized + Send + Sync,

type Allocator = SimpleMarkerAllocator<T>

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

impl<T> MarkerAllocator<SimpleMarker<T>> for SimpleMarkerAllocator<T>

where T: 'static + ?Sized + Send + Sync,

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

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<'_, SimpleMarker<T>>, )

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<T: ?Sized> PartialEq for SimpleMarker<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: ?Sized> Serialize for SimpleMarker<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: ?Sized> Copy for SimpleMarker<T>

impl<T: ?Sized> Eq for SimpleMarker<T>