Struct SubWorld 

pub struct SubWorld<'a> { /* private fields */ }

Provides access to a subset of the entities of a World.

Implementations

impl<'a> SubWorld<'a>

pub unsafe fn new_unchecked( world: &'a World, access: &'a Permissions<ComponentTypeId>, archetypes: &'a ArchetypeAccess, ) -> Self

Constructs a new SubWorld.

Safety

Queries assume that this type has been constructed correctly. Ensure that sub-worlds represent disjoint portions of a world and that the world is not used while any of its sub-worlds are alive.

pub fn split<'b, T: for<'v> View<'v>>( &'b mut self, ) -> (SubWorld<'b>, SubWorld<'b>)

where 'a: 'b,

Splits the world into two. The left world allows access only to the data declared by the view; the right world allows access to all else.

pub fn split_for_query<'q, V: for<'v> View<'v>, F: EntityFilter>( &mut self, _: &'q Query<V, F>, ) -> (SubWorld<'_>, SubWorld<'_>)

Splits the world into two. The left world allows access only to the data declared by the query’s view; the right world allows access to all else.

Trait Implementations

impl<'a> Clone for SubWorld<'a>

fn clone(&self) -> SubWorld<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> EntityStore for SubWorld<'a>

fn has_component<T: Component>(&self, entity: Entity) -> bool

Checks that the provided Component is present on a given entity.

fn has_component_by_id( &self, entity: Entity, component: ComponentTypeId, ) -> bool

Checks that the provided ComponentTypeId is present on a given entity.

fn get_component<T: Component>(&self, entity: Entity) -> Option<Ref<'_, T>>

Borrows component data for the given entity.

unsafe fn get_component_mut_unchecked<T: Component>( &self, entity: Entity, ) -> Option<RefMut<'_, T>>

Borrows component data for the given entity. Does not perform static borrow checking.

fn get_tag<T: Tag>(&self, entity: Entity) -> Option<&T>

Gets tag data for the given entity.

fn is_alive(&self, entity: Entity) -> bool

Determines if the given Entity is alive within this World.

fn get_component_storage<V: for<'b> View<'b>>( &self, ) -> Result<StorageAccessor<'_>, ComponentAccessError>

Gets the entity component storage. Validates that the world can provide access to everything needed by the view.

fn get_component_mut<T: Component>( &mut self, entity: Entity, ) -> Option<RefMut<'_, T>>

Mutably borrows entity data for the given entity.

impl<'a> From<&'a mut World> for SubWorld<'a>

fn from(world: &'a mut World) -> Self

Converts to this type from the input type.