Struct bevy::ecs::archetype::ArchetypeId

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

An opaque unique ID for a single Archetype within a World.

Archetype IDs are only valid for a given World, and are not globally unique. Attempting to use an archetype ID on a world that it wasn’t sourced from will not return the archetype with the same components. The only exception to this is EMPTY which is guaranteed to be identical for all Worlds.

Implementations

impl ArchetypeId

pub const EMPTY: ArchetypeId = _

The ID for the Archetype without any components.

pub const INVALID: ArchetypeId = _

Safety:

This must always have an all-1s bit pattern to ensure soundness in fast entity id space allocation.

pub const fn new(index: usize) -> ArchetypeId

Create an ArchetypeId from a plain value.

This is useful if you need to store the ArchetypeId as a plain value, for example in a specialized data structure such as a bitset.

While it doesn’t break any safety invariants, you should ensure the values comes from a pre-existing ArchetypeId::index in this world to avoid panics and other unexpected behaviors.

pub fn index(self) -> usize

The plain value of this ArchetypeId.

In bevy, this is mostly used to store archetype ids in FixedBitSets.

Trait Implementations

impl Clone for ArchetypeId

fn clone(&self) -> ArchetypeId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArchetypeId

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

Formats the value using the given formatter.

impl Hash for ArchetypeId

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

where __H: Hasher,

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 Index<ArchetypeId> for Archetypes

type Output = Archetype

The returned type after indexing.

fn index( &self, index: ArchetypeId ) -> &<Archetypes as Index<ArchetypeId>>::Output

Performs the indexing (container[index]) operation.

impl IndexMut<ArchetypeId> for Archetypes

fn index_mut( &mut self, index: ArchetypeId ) -> &mut <Archetypes as Index<ArchetypeId>>::Output

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

impl Ord for ArchetypeId

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

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

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

impl Eq for ArchetypeId

impl StructuralEq for ArchetypeId

impl StructuralPartialEq for ArchetypeId