Struct Entity

pub struct Entity { /* private fields */ }

Represents an entity with a unique id and a generation to track lifecycle and version.

Implementations

impl Entity

pub fn is_valid__intuicio_function(context: &mut Context, registry: &Registry)

pub fn is_valid__define_signature(registry: &Registry) -> FunctionSignature

pub fn is_valid__define_function(registry: &Registry) -> Function

pub fn id__intuicio_function(context: &mut Context, registry: &Registry)

pub fn id__define_signature(registry: &Registry) -> FunctionSignature

pub fn id__define_function(registry: &Registry) -> Function

pub fn generation__intuicio_function(context: &mut Context, registry: &Registry)

pub fn generation__define_signature(registry: &Registry) -> FunctionSignature

pub fn generation__define_function(registry: &Registry) -> Function

pub fn to_u64__intuicio_function(context: &mut Context, registry: &Registry)

pub fn to_u64__define_signature(registry: &Registry) -> FunctionSignature

pub fn to_u64__define_function(registry: &Registry) -> Function

pub fn from_u64__intuicio_function(context: &mut Context, registry: &Registry)

pub fn from_u64__define_signature(registry: &Registry) -> FunctionSignature

pub fn from_u64__define_function(registry: &Registry) -> Function

impl Entity

pub const INVALID: Self

A constant representing an invalid Entity, which is the result of an invalid id.

pub const fn new(id: u32, generation: u32) -> Option<Self>

Creates a new Entity with the specified id and generation if the id is valid. Returns None if the id is invalid (e.g., equals u32::MAX).

pub const unsafe fn new_unchecked(id: u32, generation: u32) -> Self

Safety

This method is unsafe because it bypasses the validity check for id and generation. It’s the caller’s responsibility to ensure the id and generation are appropriate, as an invalid id (such as u32::MAX) could cause undefined behavior in the ECS system.

pub const fn is_valid(self) -> bool

Returns true if the Entity is valid, meaning the id is not equal to u32::MAX.

pub const fn id(self) -> u32

Returns the id of the Entity.

pub const fn generation(self) -> u32

Returns the generation of the Entity.

pub const fn to_u64(self) -> u64

Converts the Entity into a u64 representation combining the generation and id.

pub const fn from_u64(value: u64) -> Self

Converts a u64 value back into an Entity, decoding the generation and id.

impl Entity

pub fn install(registry: &mut Registry)

Registers the Entity type and its associated methods in the given registry.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for Entity

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Entity

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

Formats the value using the given formatter.

impl FromIterator<Entity> for Multity

fn from_iter<T: IntoIterator<Item = Entity>>(iter: T) -> Self

Creates a value from an iterator.

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

fn define_struct(registry: &Registry) -> Struct

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a, const LOCKING: bool> TypedLookupFetch<'a, LOCKING> for Entity

type Value = Entity

type ValueOne = <Entity as TypedLookupFetch<'a, LOCKING>>::Value

type Access = &'a EntityDenseMap

fn try_access(archetype: &'a Archetype) -> Option<Self::Access>

fn fetch(access: &mut Self::Access, entity: Entity) -> Option<Self::Value>

fn fetch_one(_: &World, entity: Entity) -> Option<Self::ValueOne>

fn unique_access(output: &mut HashSet<TypeHash>)

impl<'a, const LOCKING: bool> TypedQueryFetch<'a, LOCKING> for Entity

type Value = Entity

type Access = Box<dyn Iterator<Item = Entity> + 'a>

fn does_accept_archetype(_: &Archetype) -> bool

fn access(archetype: &'a Archetype) -> Result<Self::Access, QueryError>

fn fetch(access: &mut Self::Access) -> Option<Self::Value>

fn unique_access(output: &mut HashSet<TypeHash>)

impl<'a> TypedRelationLookupFetch<'a> for Entity

type Value = Entity

type Access = Option<Entity>

fn access(_: &'a World, entity: Entity) -> Self::Access

fn fetch(access: &mut Self::Access) -> Option<Self::Value>

impl<'a> TypedRelationLookupTransform<'a> for Entity

type Input = Entity

type Output = Entity

fn transform( _: &'a World, input: Self::Input, ) -> impl Iterator<Item = Self::Output>

impl Copy for Entity

impl Eq for Entity

impl StructuralPartialEq for Entity