Struct bevy_ecs::archetype::Archetypes

source ·
pub struct Archetypes { /* private fields */ }
Expand description

The backing store of all Archetypes within a World.

For more information, see the module level documentation.

Implementations§

source§

impl Archetypes

source

pub fn generation(&self) -> ArchetypeGeneration

Returns the “generation”, a handle to the current highest archetype ID.

This can be used with the Index Archetypes implementation to iterate over newly introduced Archetypes since the last time this function was called.

source

pub fn len(&self) -> usize

Fetches the total number of Archetypes within the world.

source

pub fn empty(&self) -> &Archetype

Fetches an immutable reference to the archetype without any components.

Shorthand for archetypes.get(ArchetypeId::EMPTY).unwrap()

source

pub fn get(&self, id: ArchetypeId) -> Option<&Archetype>

Fetches an immutable reference to an Archetype using its ID. Returns None if no corresponding archetype exists.

source

pub fn iter(&self) -> impl Iterator<Item = &Archetype>

Returns a read-only iterator over all archetypes.

source

pub fn archetype_components_len(&self) -> usize

Returns the number of components that are stored in archetypes. Note that if some component T is stored in more than one archetype, it will be counted once for each archetype it’s present in.

Trait Implementations§

source§

impl Index<ArchetypeId> for Archetypes

§

type Output = Archetype

The returned type after indexing.
source§

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

Performs the indexing (container[index]) operation. Read more
source§

impl Index<RangeFrom<ArchetypeGeneration>> for Archetypes

§

type Output = [Archetype]

The returned type after indexing.
source§

fn index(&self, index: RangeFrom<ArchetypeGeneration>) -> &Self::Output

Performs the indexing (container[index]) operation. Read more
source§

impl IndexMut<ArchetypeId> for Archetypes

source§

fn index_mut(&mut self, index: ArchetypeId) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation. Read more
source§

impl<'a> SystemParam for &'a Archetypes

§

type State = ()

Used to store data which persists across invocations of a system.
§

type Item<'w, 's> = &'w Archetypes

The item type returned when constructing this system param. The value of this associated type should be Self, instantiated with new lifetimes. Read more
source§

fn init_state(_world: &mut World, _system_meta: &mut SystemMeta) -> Self::State

Registers any World access used by this SystemParam and creates a new instance of this param’s State.
source§

unsafe fn get_param<'w, 's>( _state: &'s mut Self::State, _system_meta: &SystemMeta, world: UnsafeWorldCell<'w>, _change_tick: Tick ) -> Self::Item<'w, 's>

Creates a parameter to be passed into a SystemParamFunction. Read more
source§

unsafe fn new_archetype( state: &mut Self::State, archetype: &Archetype, system_meta: &mut SystemMeta )

For the specified Archetype, registers the components accessed by this SystemParam (if applicable).a Read more
source§

fn apply(state: &mut Self::State, system_meta: &SystemMeta, world: &mut World)

Applies any deferred mutations stored in this SystemParam’s state. This is used to apply Commands during apply_deferred.
source§

fn queue( state: &mut Self::State, system_meta: &SystemMeta, world: DeferredWorld<'_> )

Queues any deferred mutations to be applied at the next apply_deferred.
source§

impl<'a> ReadOnlySystemParam for &'a Archetypes

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Downcast for T
where T: Any,

source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> ConditionalSend for T
where T: Send,