Struct goggles::entity::Entity

pub struct Entity { /* fields omitted */ }

Entities are unqiue "generational indexes" with low-valued index values that are appropriate as indexes into contiguous arrays.

In order to make sure every Entity is unique, allocating an Entity with the same index will result in an incremented generation field.

No two entities will share the same index and generation, so every created Entity is unique.

Implementations

impl Entity

pub fn index(self) -> Index

The low-valued index of the Entity.

pub fn generation(self) -> u32

The entity's generation.

This will never be zero.

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