Struct shipyard::EntityId

#[repr(transparent)]pub struct EntityId(_);

Handle to an entity.

Implementations

impl EntityId

pub fn from_index_and_gen(index: u64, gen: u32) -> EntityId

This is supported on crate feature serde1 only.

Make an EntityId from an index and generation.

impl EntityId

pub fn index(self) -> u64

Returns the index part of the EntityId.
⚠️ You shouldn’t use it to index a storage.

pub fn uindex(self) -> usize

Returns the index part of the EntityId as an usize.
⚠️ You shouldn’t use it to index a storage.

pub fn gen(self) -> u64

Returns the generation part of the EntityId.

pub fn dead() -> Self

Returns a dead EntityId, it can be used as a null entity.

pub fn inner(self) -> u64

Returns EntityId’s inner representation.

pub fn from_inner(inner: u64) -> Option<EntityId>

Build an EntityId from its inner representation.

Trait Implementations

impl Clone for EntityId

fn clone(&self) -> EntityId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EntityId

impl Debug for EntityId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EntityId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for EntityId

impl Hash for EntityId

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T> Index<EntityId> for SparseSet<T>

type Output = T

The returned type after indexing.

fn index(&self, entity: EntityId) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<EntityId> for SparseSet<T>

fn index_mut(&mut self, entity: EntityId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for EntityId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<EntityId> for EntityId

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<EntityId> for EntityId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for EntityId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for EntityId