Struct hecs::Entity [−][src]
pub struct Entity { /* fields omitted */ }
Expand description
Lightweight unique ID, or handle, of an entity
Obtained from World::spawn
. Can be stored to refer to an entity in the future.
Enable the serde
feature on the crate to make this Serialize
able. Some applications may be
able to save space by only serializing the output of Entity::id
.
Implementations
Convert to a form convenient for passing outside of rust
No particular structure is guaranteed for the returned bits.
Useful for storing entity IDs externally, or in conjunction with Entity::from_bits
and
World::spawn_at
for easy serialization. Alternatively, consider id
for more compact
representation.
Reconstruct an Entity
previously destructured with to_bits
if the bitpattern is valid,
else None
Useful for storing entity IDs externally, or in conjunction with Entity::to_bits
and
World::spawn_at
for easy serialization.
Extract a transiently unique identifier
No two simultaneously-live entities share the same ID, but dead entities’ IDs may collide with both live and dead entities. Useful for compactly representing entities within a specific snapshot of the world, such as when serializing.
See also World::find_entity_from_id
.
Trait Implementations
Deserialize this value from the given Serde deserializer. Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for Entity
impl UnwindSafe for Entity
Blanket Implementations
Mutably borrows from an owned value. Read more