Struct Entity

pub struct Entity { /* private fields */ }

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 Serializeable. Some applications may be able to save space by only serializing the output of Entity::id.

Implementations

impl Entity

pub const DANGLING: Entity

An Entity that does not necessarily correspond to data in any World

Useful as a dummy value. It is possible (albeit unlikely) for a World to contain this entity.

pub const fn to_bits(self) -> NonZero<u64>

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 const fn from_bits(bits: u64) -> Option<Entity>

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.

pub const 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.

See also World::find_entity_from_id.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entity

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

Formats the value using the given formatter.

impl EntityExtensions for Entity

fn to_user_data(&self) -> u128

impl Hash for Entity

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Entity

fn eq(&self, other: &Entity) -> 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 PartialOrd 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: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Entity

impl Eq for Entity

impl StructuralPartialEq for Entity