Struct Entity 

pub struct Entity { /* private fields */ }

A live entity handle: a slot index plus the generation that slot carried when the handle was minted.

Implementations

impl Entity

pub fn index(self) -> u32

The entity’s slot index.

pub fn generation(self) -> u32

The generation the slot carried when this handle was minted.

pub fn to_bits(self) -> u64

Pack into a single u64 (index in the high half, generation in the low half). Stable representation for an FFI / scripting boundary.

pub fn from_bits(bits: u64) -> Option<Entity>

Inverse of to_bits. Returns None when the generation half is zero, which no live handle ever has, so a zeroed or truncated value is rejected instead of forged into a valid-looking entity.

pub fn dangling() -> Entity

A handle the allocator never hands out (the top index is unreachable in practice). For a runtime-only component that has to name an Entity field but is never built from serialized args – its real value is inserted at runtime, so this placeholder is never observed by any system.

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 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 From<Entity> for EntityTarget

fn from(entity: Entity) -> Self

Converts to this type from the input type.

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, 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

Equality operator ==.

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

Inequality operator !=.

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