Struct EntityRow 

pub struct EntityRow(/* private fields */);

This represents the row or “index” of an Entity within the Entities table. This is a lighter weight version of Entity.

This is a unique identifier for an entity in the world. This differs from Entity in that Entity is unique for all entities total (unless the Entity::generation wraps), but this is only unique for entities that are active.

This can be used over Entity to improve performance in some cases, but improper use can cause this to identify a different entity than intended. Use with caution.

Implementations

impl EntityRow

pub const fn new(index: NonMaxU32) -> Self

Constructs a new EntityRow from its index.

pub const fn from_raw_u32(index: u32) -> Option<Self>

Equivalent to new except that it takes a u32 instead of a NonMaxU32.

Returns None if the index is u32::MAX.

pub const fn index(self) -> u32

Gets the index of the entity.

Trait Implementations

impl Clone for EntityRow

fn clone(&self) -> EntityRow

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRow

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

Formats the value using the given formatter.

impl Display for EntityRow

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

Formats the value using the given formatter.

impl Hash for EntityRow

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 EntityRow

fn cmp(&self, other: &EntityRow) -> 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 EntityRow

fn eq(&self, other: &EntityRow) -> 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 EntityRow

fn partial_cmp(&self, other: &EntityRow) -> 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 SparseSetIndex for EntityRow

fn sparse_set_index(&self) -> usize

Gets the sparse set index corresponding to this instance.

fn get_sparse_set_index(value: usize) -> Self

Creates a new instance of this type with the specified index.

impl Copy for EntityRow

impl Eq for EntityRow

impl StructuralPartialEq for EntityRow