Struct shipyard::EntityId

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

Handle to an entity.

Implementations

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) -> u16

Returns the generation part of the EntityId.

pub const fn new_from_index_and_gen(index: u64, gen: u16) -> Self

Build a new EntityId with the given index and generation.

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.

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

Performs copy-assignment from source.

impl Debug for EntityId

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

Formats the value using the given formatter.

impl Default for EntityId

Allows EntityId to be stored in collections requiring Default, like TinyVec.

fn default() -> Self

Returns the “default value” for a type.

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 Hash for EntityId

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<T: Component> Index<EntityId> for View<'_, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T: Component> Index<EntityId> for ViewMut<'a, T>

type Output = T

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<'a, T: Component<Tracking = All>> IndexMut<EntityId> for ViewMut<'a, T, All>

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

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

impl<'a, T: Component<Tracking = Deletion>> IndexMut<EntityId> for ViewMut<'a, T, Deletion>

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

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

impl<'a, T: Component<Tracking = Insertion>> IndexMut<EntityId> for ViewMut<'a, T, Insertion>

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

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

impl<'a, T: Component<Tracking = Modification>> IndexMut<EntityId> for ViewMut<'a, T, Modification>

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

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

impl<'a, T: Component<Tracking = Removal>> IndexMut<EntityId> for ViewMut<'a, T, Removal>

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

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

impl<'a, T: Component<Tracking = Untracked>> IndexMut<EntityId> for ViewMut<'a, T, Untracked>

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: &EntityId) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for EntityId

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for EntityId

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

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

impl Eq for EntityId

impl StructuralPartialEq for EntityId