Struct hecs::Entity [−][src]
pub struct Entity { /* fields omitted */ }
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
impl Entity
[src]
impl Entity
[src]pub fn to_bits(self) -> u64
[src]
pub fn to_bits(self) -> u64
[src]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.
pub fn from_bits(bits: u64) -> Self
[src]
pub fn from_bits(bits: u64) -> Self
[src]Reconstruct an Entity
previously destructured with to_bits
Useful for storing entity IDs externally, or in conjunction with Entity::to_bits
and
World::spawn_at
for easy serialization.
pub fn id(self) -> u32
[src]
pub fn id(self) -> u32
[src]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
impl<'de> Deserialize<'de> for Entity
[src]
impl<'de> Deserialize<'de> for Entity
[src]fn deserialize<D>(deserializer: D) -> Result<Entity, D::Error> where
D: Deserializer<'de>,
[src]
fn deserialize<D>(deserializer: D) -> Result<Entity, D::Error> where
D: Deserializer<'de>,
[src]Deserialize this value from the given Serde deserializer. Read more
impl Ord for Entity
[src]
impl Ord for Entity
[src]impl PartialOrd<Entity> for Entity
[src]
impl PartialOrd<Entity> for Entity
[src]fn partial_cmp(&self, other: &Entity) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &Entity) -> Option<Ordering>
[src]This method returns an ordering between self
and other
values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than (for self
and other
) and is used by the <
operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool
1.0.0[src]This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Entity
[src]
impl Eq for Entity
[src]
impl StructuralEq for Entity
[src]
impl StructuralPartialEq for Entity
[src]
Auto Trait Implementations
impl RefUnwindSafe for Entity
impl Send for Entity
impl Sync for Entity
impl Unpin for Entity
impl UnwindSafe for Entity
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,