Struct FilteredEntityMut

pub struct FilteredEntityMut<'w, 's> { /* private fields */ }

Provides mutable access to a single entity and some of its components defined by the contained Access.

To define the access when used as a QueryData, use a QueryBuilder or QueryParamBuilder. The FilteredEntityMut must be the entire QueryData, and not nested inside a tuple with other data.

// This gives the `FilteredEntityMut` access to `&mut A`.
let mut query = QueryBuilder::<FilteredEntityMut>::new(&mut world)
    .data::<&mut A>()
    .build();

let mut filtered_entity: FilteredEntityMut = query.single_mut(&mut world).unwrap();
let component: Mut<A> = filtered_entity.get_mut().unwrap();

Also see UnsafeFilteredEntityMut for a way to bypass borrow-checker restrictions.

Implementations

impl<'w, 's> FilteredEntityMut<'w, 's>

pub fn reborrow(&mut self) -> FilteredEntityMut<'_, 's>

Returns a new instance with a shorter lifetime. This is useful if you have &mut FilteredEntityMut, but you need FilteredEntityMut.

pub fn as_readonly(&self) -> FilteredEntityRef<'_, 's>

Gets read-only access to all of the entity’s components.

pub fn as_unsafe_entity_cell(&mut self) -> UnsafeEntityCell<'_>

Get access to the underlying UnsafeEntityCell

pub fn id(&self) -> Entity

Returns the ID of the current entity.

pub fn location(&self) -> EntityLocation

Gets metadata indicating the location where the current entity is stored.

pub fn archetype(&self) -> &Archetype

Returns the archetype that the current entity belongs to.

pub fn access(&self) -> &Access

Returns a reference to the underlying Access.

pub fn contains<T>(&self) -> bool

where T: Component,

Returns true if the current entity has a component of type T. Otherwise, this returns false.

Notes

If you do not know the concrete type of a component, consider using Self::contains_id or Self::contains_type_id.

pub fn contains_id(&self, component_id: ComponentId) -> bool

Returns true if the current entity has a component identified by component_id. Otherwise, this returns false.

Notes

• If you know the concrete type of the component, you should prefer Self::contains.
• If you know the component’s TypeId but not its ComponentId, consider using Self::contains_type_id.

pub fn contains_type_id(&self, type_id: TypeId) -> bool

Returns true if the current entity has a component with the type identified by type_id. Otherwise, this returns false.

Notes

• If you know the concrete type of the component, you should prefer Self::contains.
• If you have a ComponentId instead of a TypeId, consider using Self::contains_id.

pub fn get<T>(&self) -> Option<&T>

where T: Component,

Gets access to the component of type T for the current entity. Returns None if the entity does not have a component of type T.

pub fn get_ref<T>(&self) -> Option<Ref<'_, T>>

where T: Component,

Gets access to the component of type T for the current entity, including change detection information as a Ref.

Returns None if the entity does not have a component of type T.

pub fn get_mut<T>(&mut self) -> Option<Mut<'_, T>>

where T: Component<Mutability = Mutable>,

Gets mutable access to the component of type T for the current entity. Returns None if the entity does not have a component of type T or if the access does not include write access to T.

pub unsafe fn get_mut_unchecked<T>(&self) -> Option<Mut<'_, T>>

where T: Component<Mutability = Mutable>,

Gets mutable access to the component of type T for the current entity. Returns None if the entity does not have a component of type T or if the access does not include write access to T.

This only requires &self, and so may be used to get mutable access to multiple components.

Example

#[derive(Component)]
struct X(usize);
#[derive(Component)]
struct Y(usize);

let mut entity = world.spawn((X(0), Y(0))).into_mutable();

// This gives the `FilteredEntityMut` access to `&mut X` and `&mut Y`.
let mut query = QueryBuilder::<FilteredEntityMut>::new(&mut world)
    .data::<(&mut X, &mut Y)>()
    .build();

let mut filtered_entity: FilteredEntityMut = query.single_mut(&mut world).unwrap();

// Get mutable access to two components at once
// SAFETY: We don't take any other references to `X` from this entity
let mut x = unsafe { filtered_entity.get_mut_unchecked::<X>() }.unwrap();
// SAFETY: We don't take any other references to `Y` from this entity
let mut y = unsafe { filtered_entity.get_mut_unchecked::<Y>() }.unwrap();
*x = X(1);
*y = Y(1);

Safety

No other references to the same component may exist at the same time as the returned reference.

See also

• get_mut for the safe version.

pub fn into_mut<T>(self) -> Option<Mut<'w, T>>

where T: Component<Mutability = Mutable>,

Consumes self and gets mutable access to the component of type T with the world 'w lifetime for the current entity. Returns None if the entity does not have a component of type T.

pub unsafe fn into_mut_assume_mutable<T>(self) -> Option<Mut<'w, T>>

where T: Component,

Consumes self and gets mutable access to the component of type T with the world 'w lifetime for the current entity. Returns None if the entity does not have a component of type T.

Safety

• T must be a mutable component

pub fn get_change_ticks<T>(&self) -> Option<ComponentTicks>

where T: Component,

Retrieves the change ticks for the given component. This can be useful for implementing change detection in custom runtimes.

pub fn get_change_ticks_by_id( &self, component_id: ComponentId, ) -> Option<ComponentTicks>

Retrieves the change ticks for the given ComponentId. This can be useful for implementing change detection in custom runtimes.

You should prefer to use the typed API Self::get_change_ticks where possible and only use this in cases where the actual component types are not known at compile time.

pub fn get_by_id(&self, component_id: ComponentId) -> Option<Ptr<'_>>

Gets the component of the given ComponentId from the entity.

You should prefer to use the typed API Self::get where possible and only use this in cases where the actual component types are not known at compile time.

Unlike FilteredEntityMut::get, this returns a raw pointer to the component, which is only valid while the FilteredEntityMut is alive.

pub fn get_mut_by_id( &mut self, component_id: ComponentId, ) -> Option<MutUntyped<'_>>

Gets a MutUntyped of the component of the given ComponentId from the entity.

You should prefer to use the typed API Self::get_mut where possible and only use this in cases where the actual component types are not known at compile time.

Unlike FilteredEntityMut::get_mut, this returns a raw pointer to the component, which is only valid while the FilteredEntityMut is alive.

pub unsafe fn get_mut_by_id_unchecked( &self, component_id: ComponentId, ) -> Option<MutUntyped<'_>>

Gets a MutUntyped of the component of the given ComponentId from the entity.

You should prefer to use the typed API Self::get_mut where possible and only use this in cases where the actual component types are not known at compile time.

Unlike FilteredEntityMut::get_mut, this returns a raw pointer to the component, which is only valid while the FilteredEntityMut is alive.

This only requires &self, and so may be used to get mutable access to multiple components.

Safety

No other references to the same component may exist at the same time as the returned reference.

See also

• get_mut_by_id for the safe version.

pub fn spawned_by(&self) -> MaybeLocation

Returns the source code location from which this entity has last been spawned.

pub fn spawn_tick(&self) -> Tick

Returns the Tick at which this entity has been spawned.

Trait Implementations

impl ContainsEntity for FilteredEntityMut<'_, '_>

fn entity(&self) -> Entity

Returns the contained entity.

impl<'w, 's> From<&'w FilteredEntityMut<'_, 's>> for FilteredEntityRef<'w, 's>

fn from(entity: &'w FilteredEntityMut<'_, 's>) -> FilteredEntityRef<'w, 's>

Converts to this type from the input type.

impl<'a> From<&'a mut EntityMut<'_>> for FilteredEntityMut<'a, 'static>

fn from(entity: &'a mut EntityMut<'_>) -> FilteredEntityMut<'a, 'static>

Converts to this type from the input type.

impl<'w, 's, B> From<&'w mut EntityMutExcept<'_, 's, B>> for FilteredEntityMut<'w, 's>

where B: Bundle,

fn from(value: &'w mut EntityMutExcept<'_, 's, B>) -> FilteredEntityMut<'w, 's>

Converts to this type from the input type.

impl<'a> From<&'a mut EntityWorldMut<'_>> for FilteredEntityMut<'a, 'static>

fn from(entity: &'a mut EntityWorldMut<'_>) -> FilteredEntityMut<'a, 'static>

Converts to this type from the input type.

impl<'a> From<EntityMut<'a>> for FilteredEntityMut<'a, 'static>

fn from(entity: EntityMut<'a>) -> FilteredEntityMut<'a, 'static>

Converts to this type from the input type.

impl<'a> From<EntityWorldMut<'a>> for FilteredEntityMut<'a, 'static>

fn from(entity: EntityWorldMut<'a>) -> FilteredEntityMut<'a, 'static>

Converts to this type from the input type.

impl<'w, 's> From<FilteredEntityMut<'w, 's>> for FilteredEntityRef<'w, 's>

fn from(entity: FilteredEntityMut<'w, 's>) -> FilteredEntityRef<'w, 's>

Converts to this type from the input type.

impl Hash for FilteredEntityMut<'_, '_>

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 Ord for FilteredEntityMut<'_, '_>

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

Restrict a value to a certain interval.

impl PartialEq for FilteredEntityMut<'_, '_>

fn eq(&self, other: &FilteredEntityMut<'_, '_>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for FilteredEntityMut<'_, '_>

fn partial_cmp(&self, other: &FilteredEntityMut<'_, '_>) -> Option<Ordering>

FilteredEntityMut’s comparison trait implementations match the underlying Entity, and cannot discern between different worlds.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, 'b> QueryData for FilteredEntityMut<'a, 'b>

SAFETY: access of FilteredEntityRef is a subset of FilteredEntityMut

const IS_READ_ONLY: bool = false

True if this query is read-only and may not perform mutable access.

const IS_ARCHETYPAL: bool = true

Returns true if (and only if) this query data relies strictly on archetypes to limit which entities are accessed by the Query.

type ReadOnly = FilteredEntityRef<'a, 'b>

The read-only variant of this QueryData, which satisfies the ReadOnlyQueryData trait.

type Item<'w, 's> = FilteredEntityMut<'w, 's>

The item returned by this WorldQuery This will be the data retrieved by the query, and is visible to the end user when calling e.g. Query<Self>::get.

fn shrink<'wlong, 'wshort, 's>( item: <FilteredEntityMut<'a, 'b> as QueryData>::Item<'wlong, 's>, ) -> <FilteredEntityMut<'a, 'b> as QueryData>::Item<'wshort, 's>

where 'wlong: 'wshort,

This function manually implements subtyping for the query items.

fn provide_extra_access( state: &mut <FilteredEntityMut<'a, 'b> as WorldQuery>::State, access: &mut Access, available_access: &Access, )

Offers additional access above what we requested in update_component_access. Implementations may add additional access that is a subset of available_access and does not conflict with anything in access, and must update access to include that access.

unsafe fn fetch<'w, 's>( access: &'s <FilteredEntityMut<'a, 'b> as WorldQuery>::State, fetch: &mut <FilteredEntityMut<'a, 'b> as WorldQuery>::Fetch<'w>, entity: Entity, _table_row: TableRow, ) -> Option<<FilteredEntityMut<'a, 'b> as QueryData>::Item<'w, 's>>

Fetch Self::Item for either the given entity in the current Table, or for the given entity in the current Archetype. This must always be called after WorldQuery::set_table with a table_row in the range of the current Table or after WorldQuery::set_archetype with an entity in the current archetype. Accesses components registered in WorldQuery::update_component_access.

fn iter_access( state: &<FilteredEntityMut<'a, 'b> as WorldQuery>::State, ) -> impl Iterator<Item = EcsAccessType<'_>>

Returns an iterator over the access needed by QueryData::fetch. Access conflicts are usually checked in WorldQuery::update_component_access, but in certain cases this method can be useful to implement a way of checking for access conflicts in a non-allocating way.

impl<'a> TryFrom<&'a FilteredEntityMut<'_, '_>> for EntityRef<'a>

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

fn try_from( entity: &'a FilteredEntityMut<'_, '_>, ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<&'a FilteredEntityMut<'_, '_>>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut FilteredEntityMut<'_, '_>> for EntityMut<'a>

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

fn try_from( entity: &'a mut FilteredEntityMut<'_, '_>, ) -> Result<EntityMut<'a>, <EntityMut<'a> as TryFrom<&'a mut FilteredEntityMut<'_, '_>>>::Error>

Performs the conversion.

impl<'a> TryFrom<FilteredEntityMut<'a, '_>> for EntityMut<'a>

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

fn try_from( entity: FilteredEntityMut<'a, '_>, ) -> Result<EntityMut<'a>, <EntityMut<'a> as TryFrom<FilteredEntityMut<'a, '_>>>::Error>

Performs the conversion.

impl<'a> TryFrom<FilteredEntityMut<'a, '_>> for EntityRef<'a>

type Error = TryFromFilteredError

The type returned in the event of a conversion error.

fn try_from( entity: FilteredEntityMut<'a, '_>, ) -> Result<EntityRef<'a>, <EntityRef<'a> as TryFrom<FilteredEntityMut<'a, '_>>>::Error>

Performs the conversion.

impl WorldQuery for FilteredEntityMut<'_, '_>

SAFETY: The accesses of Self::ReadOnly are a subset of the accesses of Self

const IS_DENSE: bool = true

Returns true if (and only if) every table of every archetype matched by this fetch contains all of the matched components.

type Fetch<'w> = EntityFetch<'w>

Per archetype/table state retrieved by this WorldQuery to compute Self::Item for each entity.

type State = Access

State used to construct a Self::Fetch. This will be cached inside QueryState, so it is best to move as much data / computation here as possible to reduce the cost of constructing Self::Fetch.

fn shrink_fetch<'wlong, 'wshort>( fetch: <FilteredEntityMut<'_, '_> as WorldQuery>::Fetch<'wlong>, ) -> <FilteredEntityMut<'_, '_> as WorldQuery>::Fetch<'wshort>

where 'wlong: 'wshort,

This function manually implements subtyping for the query fetches.

unsafe fn init_fetch<'w, 's>( world: UnsafeWorldCell<'w>, _state: &'s <FilteredEntityMut<'_, '_> as WorldQuery>::State, last_run: Tick, this_run: Tick, ) -> <FilteredEntityMut<'_, '_> as WorldQuery>::Fetch<'w>

Creates a new instance of Self::Fetch, by combining data from the World with the cached Self::State. Readonly accesses resources registered in WorldQuery::update_component_access.

unsafe fn set_archetype<'w, 's>( _fetch: &mut <FilteredEntityMut<'_, '_> as WorldQuery>::Fetch<'w>, _state: &'s <FilteredEntityMut<'_, '_> as WorldQuery>::State, _: &'w Archetype, _table: &Table, )

Adjusts internal state to account for the next Archetype. This will always be called on archetypes that match this WorldQuery.

unsafe fn set_table<'w, 's>( _fetch: &mut <FilteredEntityMut<'_, '_> as WorldQuery>::Fetch<'w>, _state: &'s <FilteredEntityMut<'_, '_> as WorldQuery>::State, _: &'w Table, )

Adjusts internal state to account for the next Table. This will always be called on tables that match this WorldQuery.

fn update_component_access( state: &<FilteredEntityMut<'_, '_> as WorldQuery>::State, filtered_access: &mut FilteredAccess, )

Adds any component accesses used by this WorldQuery to access.

fn init_state( _world: &mut World, ) -> <FilteredEntityMut<'_, '_> as WorldQuery>::State

Creates and initializes a State for this WorldQuery type.

fn get_state( _components: &Components, ) -> Option<<FilteredEntityMut<'_, '_> as WorldQuery>::State>

Attempts to initialize a State for this WorldQuery type using read-only access to Components.

fn matches_component_set( _state: &<FilteredEntityMut<'_, '_> as WorldQuery>::State, _set_contains_id: &impl Fn(ComponentId) -> bool, ) -> bool

Returns true if this query matches a set of components. Otherwise, returns false.

impl ArchetypeQueryData for FilteredEntityMut<'_, '_>

impl EntityEquivalent for FilteredEntityMut<'_, '_>

impl Eq for FilteredEntityMut<'_, '_>