Struct shard_ecs::entity_registry::entity::Entity

#[repr(transparent)]
pub struct Entity { /* fields omitted */ }

Represents an abstract Entity. Is internally a handle into the ECS to query it’s associated components.

Implementations

impl Entity

pub const INVALID: Entity

pub const unsafe fn from_raw(raw: u32) -> Entity

Constructs a new Entity from a raw u32. The higher/leftmost 24 bits as index, the lower/rightmost 8 bits are used as version.

pub const fn is_valid(&self) -> bool

Returns if entity is valid, meaning it is NOT equal to Entity::INVALID.

pub const fn invalid() -> Entity

Returns the invalid entity.

pub const unsafe fn new_unchecked(index: u32, version: u8) -> Entity

Manually construct a new Entity. index MUST be lower than 2^24! Failing to uphold this invariant will corrupt the internal handle.

Safety

• index MUST be lower than 2^24!

pub const fn index(&self) -> u32

Returns the index part of the entity’s handle.

pub unsafe fn set_index(&mut self, index: u32)

Sets the index part of the entity’s handle. index MUST be lower than 2^24! Failing to uphold this invariant will corrupt the internal handle.

Safety

• index MUST be lower than 2^24!

pub const fn version(&self) -> u8

Returns the version part of the entity’s handle.

pub fn set_version(&mut self, version: u8)

Sets the version part of the entity’s handle.

pub const fn raw(&self) -> u32

Returns the raw entity handle.

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

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

Formats the value using the given formatter.

impl Default for Entity

fn default() -> Self

Returns the “default value” for a type.

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

impl Eq for Entity

impl StructuralEq for Entity

impl StructuralPartialEq for Entity