Struct hecs::Entity

pub struct Entity { /* fields omitted */ }

Lightweight unique ID of an entity

Obtained from World::spawn. Can be stored to refer to an entity in the future.

Implementations

impl Entity

pub fn to_bits(self) -> u64

Convert to a form convenient for passing outside of rust

Only useful for identifying entities within the same instance of an application. Do not use for serialization between runs.

No particular structure is guaranteed for the returned bits.

pub fn from_bits(bits: u64) -> Self

Reconstruct an Entity previously destructured with to_bits

Only useful when applied to results from to_bits in the same instance of an application.

pub fn id(self) -> u32

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.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Entity

impl Debug for Entity

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

Formats the value using the given formatter.

impl Eq for Entity

impl Hash for Entity

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 Ord for Entity

fn cmp(&self, other: &Entity) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Entity> for Entity

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

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

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

This method tests for !=.

impl PartialOrd<Entity> for Entity

fn partial_cmp(&self, other: &Entity) -> Option<Ordering>

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

fn lt(&self, other: &Entity) -> bool

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

fn le(&self, other: &Entity) -> bool

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

fn gt(&self, other: &Entity) -> bool

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

fn ge(&self, other: &Entity) -> bool

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

impl StructuralEq for Entity

impl StructuralPartialEq for Entity