Skip to content

Rename get_many() to many(), making it consistent with single() #18615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BD103 wants to merge 7 commits into from
Closed

Rename get_many() to many(), making it consistent with single() #18615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
c6a2456
refactor!: remove `get_` prefix for `QueryState`
BD103 Mar 29, 2025
dda24cd
refactor!: remove `get_` prefix from `Query`
BD103 Mar 29, 2025
8403c35
fix: doc links
BD103 Mar 30, 2025
b8ebcab
fix: doc tests
BD103 Mar 30, 2025
6da593c
fix: leftover references to `get_many()` and `get_many_mut()`
BD103 Mar 30, 2025
3bb4a11
fix: `Query` tables
BD103 Mar 30, 2025
d71643f
refactor: rustfmt
BD103 Mar 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions benches/benches/bevy_ecs/world/world_get.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -325,10 +325,7 @@ pub fn query_get_many<const N: usize>(criterion: &mut Criterion) {

bencher.iter(|| {
let mut count = 0;
for comp in entity_groups
.iter()
.filter_map(|&ids| query.get_many(ids).ok())
{
for comp in entity_groups.iter().filter_map(|&ids| query.many(ids).ok()) {
black_box(comp);
count += 1;
black_box(count);
Expand All @@ -348,10 +345,7 @@ pub fn query_get_many<const N: usize>(criterion: &mut Criterion) {

bencher.iter(|| {
let mut count = 0;
for comp in entity_groups
.iter()
.filter_map(|&ids| query.get_many(ids).ok())
{
for comp in entity_groups.iter().filter_map(|&ids| query.many(ids).ok()) {
black_box(comp);
count += 1;
black_box(count);
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/compile_fail/tests/ui/system_query_get_many_lifetime_safety.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use bevy_ecs::prelude::*;
struct A(usize);

fn system(mut query: Query<&mut A>, e: Entity) {
let a1 = query.get_many([e, e]).unwrap();
let a1 = query.many([e, e]).unwrap();
let a2 = query.get_mut(e).unwrap();
//~^ E0502
println!("{} {}", a1[0].0, a2.0);
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/compile_fail/tests/ui/system_query_get_many_lifetime_safety.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
error[E0502]: cannot borrow `query` as mutable because it is also borrowed as immutable
--> tests/ui/system_query_get_many_lifetime_safety.rs:8:14
|
7 | let a1 = query.get_many([e, e]).unwrap();
7 | let a1 = query.many([e, e]).unwrap();
| ----- immutable borrow occurs here
8 | let a2 = query.get_mut(e).unwrap();
| ^^^^^^^^^^^^^^^^ mutable borrow occurs here
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/compile_fail/tests/ui/system_query_get_many_mut_lifetime_safety.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ use bevy_ecs::prelude::*;
struct A(usize);

fn system(mut query: Query<&mut A>, e: Entity) {
let a1 = query.get_many_mut([e, e]).unwrap();
let a1 = query.many_mut([e, e]).unwrap();
let a2 = query.get_mut(e).unwrap();
//~^ E0499
println!("{} {}", a1[0].0, a2.0);
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/compile_fail/tests/ui/system_query_get_many_mut_lifetime_safety.stderr
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
error[E0499]: cannot borrow `query` as mutable more than once at a time
--> tests/ui/system_query_get_many_mut_lifetime_safety.rs:8:14
|
7 | let a1 = query.get_many_mut([e, e]).unwrap();
7 | let a1 = query.many_mut([e, e]).unwrap();
| ----- first mutable borrow occurs here
8 | let a2 = query.get_mut(e).unwrap();
| ^^^^^ second mutable borrow occurs here
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1830,7 +1830,7 @@ mod tests {

world.insert_batch(values);
let mut query = world.query::<(Option<&A>, &B, &C)>();
let component_values = query.get_many(&world, [e0, e1, e2]).unwrap();
let component_values = query.many(&world, [e0, e1, e2]).unwrap();

assert_eq!(
component_values,
Expand Down
2 changes: 1 addition & 1 deletion crates/bevy_ecs/src/query/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ pub enum QueryEntityError {
EntityDoesNotExist(EntityDoesNotExistError),
/// The [`Entity`] was requested mutably more than once.
///
/// See [`Query::get_many_mut`](crate::system::Query::get_many_mut) for an example.
/// See [`Query::many_mut`](crate::system::Query::many_mut) for an example.
AliasedMutability(Entity),
}

Expand Down
10 changes: 5 additions & 5 deletions crates/bevy_ecs/src/query/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -439,14 +439,14 @@ mod tests {
}

#[test]
fn get_many_only_mut_checks_duplicates() {
fn many_only_mut_checks_duplicates() {
let mut world = World::new();
let id = world.spawn(A(10)).id();
let mut query_state = world.query::<&mut A>();
let mut query = query_state.query_mut(&mut world);
let result = query.get_many([id, id]);
let result = query.many([id, id]);
assert_eq!(result, Ok([&A(10), &A(10)]));
let mut_result = query.get_many_mut([id, id]);
let mut_result = query.many_mut([id, id]);
assert!(mut_result.is_err());
}

Expand Down Expand Up @@ -763,7 +763,7 @@ mod tests {

let _: Option<&Foo> = q.get(&world, e).ok();
let _: Option<&Foo> = q.get_manual(&world, e).ok();
let _: Option<[&Foo; 1]> = q.get_many(&world, [e]).ok();
let _: Option<[&Foo; 1]> = q.many(&world, [e]).ok();
let _: Option<&Foo> = q.single(&world).ok();
let _: &Foo = q.single(&world).unwrap();

Expand All @@ -776,7 +776,7 @@ mod tests {
q.iter().for_each(|_: &Foo| ());

let _: Option<&Foo> = q.get(e).ok();
let _: Option<[&Foo; 1]> = q.get_many([e]).ok();
let _: Option<[&Foo; 1]> = q.many([e]).ok();
let _: Option<&Foo> = q.single().ok();
let _: &Foo = q.single().unwrap();
}
Expand Down
113 changes: 81 additions & 32 deletions crates/bevy_ecs/src/query/state.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -961,7 +961,7 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
/// In case of a nonexisting entity or mismatched component, a [`QueryEntityError`] is
/// returned instead.
///
/// Note that the unlike [`QueryState::get_many_mut`], the entities passed in do not need to be unique.
/// Note that the unlike [`QueryState::many_mut`], the entities passed in do not need to be unique.
///
/// # Examples
///
Expand All @@ -980,21 +980,32 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
///
/// let mut query_state = world.query::<&A>();
///
/// let component_values = query_state.get_many(&world, entities).unwrap();
/// let component_values = query_state.many(&world, entities).unwrap();
///
/// assert_eq!(component_values, [&A(0), &A(1), &A(2)]);
///
/// let wrong_entity = Entity::from_raw(365);
///
/// assert_eq!(match query_state.get_many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// ```
#[inline]
pub fn many<'w, const N: usize>(
&mut self,
world: &'w World,
entities: [Entity; N],
) -> Result<[ROQueryItem<'w, D>; N], QueryEntityError> {
self.query(world).many_inner(entities)
}

/// A deprecated alias for [`many`](Self::many).
#[inline]
#[deprecated(since = "0.16.0", note = "Please use `many` instead")]
pub fn get_many<'w, const N: usize>(
&mut self,
world: &'w World,
entities: [Entity; N],
) -> Result<[ROQueryItem<'w, D>; N], QueryEntityError> {
self.query(world).get_many_inner(entities)
self.many(world, entities)
}

/// Returns the read-only query results for the given [`UniqueEntityArray`].
Expand All @@ -1005,8 +1016,8 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
/// # Examples
///
/// ```
/// use bevy_ecs::{prelude::*, query::QueryEntityError, entity::{EntitySetIterator, unique_array::UniqueEntityArray, unique_vec::UniqueEntityVec}};
///
/// # use bevy_ecs::{prelude::*, query::QueryEntityError, entity::{EntitySetIterator, unique_array::UniqueEntityArray, unique_vec::UniqueEntityVec}};
/// #
/// #[derive(Component, PartialEq, Debug)]
/// struct A(usize);
///
Expand All @@ -1018,21 +1029,30 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
///
/// let mut query_state = world.query::<&A>();
///
/// let component_values = query_state.get_many_unique(&world, entity_set).unwrap();
/// let component_values = query_state.many_unique(&world, entity_set).unwrap();
///
/// assert_eq!(component_values, [&A(0), &A(1), &A(2)]);
///
/// let wrong_entity = Entity::from_raw(365);
///
/// assert_eq!(match query_state.get_many_unique(&mut world, UniqueEntityArray::from([wrong_entity])).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(
/// match query_state
/// .many_unique(&mut world, UniqueEntityArray::from([wrong_entity]))
/// .unwrap_err()
/// {
/// QueryEntityError::EntityDoesNotExist(error) => error.entity,
/// _ => panic!(),
/// },
/// wrong_entity,
/// );
/// ```
#[inline]
pub fn get_many_unique<'w, const N: usize>(
pub fn many_unique<'w, const N: usize>(
&mut self,
world: &'w World,
entities: UniqueEntityArray<N>,
) -> Result<[ROQueryItem<'w, D>; N], QueryEntityError> {
self.query(world).get_many_unique_inner(entities)
self.query(world).many_unique_inner(entities)
}

/// Gets the query result for the given [`World`] and [`Entity`].
Expand Down Expand Up @@ -1068,30 +1088,41 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
///
/// let mut query_state = world.query::<&mut A>();
///
/// let mut mutable_component_values = query_state.get_many_mut(&mut world, entities).unwrap();
/// let mut mutable_component_values = query_state.many_mut(&mut world, entities).unwrap();
///
/// for mut a in &mut mutable_component_values {
/// a.0 += 5;
/// }
///
/// let component_values = query_state.get_many(&world, entities).unwrap();
/// let component_values = query_state.many(&world, entities).unwrap();
///
/// assert_eq!(component_values, [&A(5), &A(6), &A(7)]);
///
/// let wrong_entity = Entity::from_raw(57);
/// let invalid_entity = world.spawn_empty().id();
///
/// assert_eq!(match query_state.get_many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.get_many_mut(&mut world, [invalid_entity]).unwrap_err() {QueryEntityError::QueryDoesNotMatch(entity, _) => entity, _ => panic!()}, invalid_entity);
/// assert_eq!(query_state.get_many_mut(&mut world, [entities[0], entities[0]]).unwrap_err(), QueryEntityError::AliasedMutability(entities[0]));
/// assert_eq!(match query_state.many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.many_mut(&mut world, [invalid_entity]).unwrap_err() {QueryEntityError::QueryDoesNotMatch(entity, _) => entity, _ => panic!()}, invalid_entity);
/// assert_eq!(query_state.many_mut(&mut world, [entities[0], entities[0]]).unwrap_err(), QueryEntityError::AliasedMutability(entities[0]));
/// ```
#[inline]
pub fn many_mut<'w, const N: usize>(
&mut self,
world: &'w mut World,
entities: [Entity; N],
) -> Result<[D::Item<'w>; N], QueryEntityError> {
self.query_mut(world).many_mut_inner(entities)
}

/// A deprecated alias for [`many_mut`](Self::many_mut).
#[inline]
#[deprecated(since = "0.16.0", note = "Please use `many_mut` instead")]
pub fn get_many_mut<'w, const N: usize>(
&mut self,
world: &'w mut World,
entities: [Entity; N],
) -> Result<[D::Item<'w>; N], QueryEntityError> {
self.query_mut(world).get_many_mut_inner(entities)
self.many_mut(world, entities)
}

/// Returns the query results for the given [`UniqueEntityArray`].
Expand All @@ -1100,8 +1131,8 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
/// returned instead.
///
/// ```
/// use bevy_ecs::{prelude::*, query::QueryEntityError, entity::{EntitySetIterator, unique_array::UniqueEntityArray, unique_vec::UniqueEntityVec}};
///
/// # use bevy_ecs::{prelude::*, query::QueryEntityError, entity::{EntitySetIterator, unique_array::UniqueEntityArray, unique_vec::UniqueEntityVec}};
/// #
/// #[derive(Component, PartialEq, Debug)]
/// struct A(usize);
///
Expand All @@ -1114,29 +1145,47 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
///
/// let mut query_state = world.query::<&mut A>();
///
/// let mut mutable_component_values = query_state.get_many_unique_mut(&mut world, entity_set).unwrap();
/// let mut mutable_component_values = query_state.many_unique_mut(&mut world, entity_set).unwrap();
///
/// for mut a in &mut mutable_component_values {
/// a.0 += 5;
/// }
///
/// let component_values = query_state.get_many_unique(&world, entity_set).unwrap();
/// let component_values = query_state.many_unique(&world, entity_set).unwrap();
///
/// assert_eq!(component_values, [&A(5), &A(6), &A(7)]);
///
/// let wrong_entity = Entity::from_raw(57);
/// let invalid_entity = world.spawn_empty().id();
///
/// assert_eq!(match query_state.get_many_unique(&mut world, UniqueEntityArray::from([wrong_entity])).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.get_many_unique_mut(&mut world, UniqueEntityArray::from([invalid_entity])).unwrap_err() {QueryEntityError::QueryDoesNotMatch(entity, _) => entity, _ => panic!()}, invalid_entity);
/// assert_eq!(
/// match query_state
/// .many_unique(&mut world, UniqueEntityArray::from([wrong_entity]))
/// .unwrap_err()
/// {
/// QueryEntityError::EntityDoesNotExist(error) => error.entity,
/// _ => panic!(),
/// },
/// wrong_entity,
/// );
/// assert_eq!(
/// match query_state
/// .many_unique_mut(&mut world, UniqueEntityArray::from([invalid_entity]))
/// .unwrap_err()
/// {
/// QueryEntityError::QueryDoesNotMatch(entity, _) => entity,
/// _ => panic!(),
/// },
/// invalid_entity,
/// );
/// ```
#[inline]
pub fn get_many_unique_mut<'w, const N: usize>(
pub fn many_unique_mut<'w, const N: usize>(
&mut self,
world: &'w mut World,
entities: UniqueEntityArray<N>,
) -> Result<[D::Item<'w>; N], QueryEntityError> {
self.query_mut(world).get_many_unique_inner(entities)
self.query_mut(world).many_unique_inner(entities)
}

/// Gets the query result for the given [`World`] and [`Entity`].
Expand Down Expand Up @@ -1448,16 +1497,16 @@ impl<D: QueryData, F: QueryFilter> QueryState<D, F> {
/// a.0 += 5;
/// });
///
/// # let component_values = query_state.get_many(&world, entities).unwrap();
/// # let component_values = query_state.many(&world, entities).unwrap();
///
/// # assert_eq!(component_values, [&A(5), &A(6), &A(7)]);
///
/// # let wrong_entity = Entity::from_raw(57);
/// # let invalid_entity = world.spawn_empty().id();
///
/// # assert_eq!(match query_state.get_many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.get_many_mut(&mut world, [invalid_entity]).unwrap_err() {QueryEntityError::QueryDoesNotMatch(entity, _) => entity, _ => panic!()}, invalid_entity);
/// # assert_eq!(query_state.get_many_mut(&mut world, [entities[0], entities[0]]).unwrap_err(), QueryEntityError::AliasedMutability(entities[0]));
/// # assert_eq!(match query_state.many(&mut world, [wrong_entity]).unwrap_err() {QueryEntityError::EntityDoesNotExist(error) => error.entity, _ => panic!()}, wrong_entity);
/// assert_eq!(match query_state.many_mut(&mut world, [invalid_entity]).unwrap_err() {QueryEntityError::QueryDoesNotMatch(entity, _) => entity, _ => panic!()}, invalid_entity);
/// # assert_eq!(query_state.many_mut(&mut world, [entities[0], entities[0]]).unwrap_err(), QueryEntityError::AliasedMutability(entities[0]));
/// ```
///
/// # Panics
Expand Down Expand Up @@ -1899,22 +1948,22 @@ mod tests {

#[test]
#[should_panic]
fn right_world_get_many() {
fn right_world_many() {
let mut world_1 = World::new();
let world_2 = World::new();

let mut query_state = world_1.query::<Entity>();
let _panics = query_state.get_many(&world_2, []);
let _panics = query_state.many(&world_2, []);
}

#[test]
#[should_panic]
fn right_world_get_many_mut() {
fn right_world_many_mut() {
let mut world_1 = World::new();
let mut world_2 = World::new();

let mut query_state = world_1.query::<Entity>();
let _panics = query_state.get_many_mut(&mut world_2, []);
let _panics = query_state.many_mut(&mut world_2, []);
}

#[derive(Component, PartialEq, Debug)]
Expand Down
6 changes: 3 additions & 3 deletions crates/bevy_ecs/src/system/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,7 @@ mod tests {
}

#[test]
fn get_many_is_ordered() {
fn many_is_ordered() {
use crate::resource::Resource;
const ENTITIES_COUNT: usize = 1000;

Expand All @@ -417,7 +417,7 @@ mod tests {
let entities_array: [Entity; ENTITIES_COUNT] =
entities_array.0.clone().try_into().unwrap();

for (i, w) in (0..ENTITIES_COUNT).zip(q.get_many(entities_array).unwrap()) {
for (i, w) in (0..ENTITIES_COUNT).zip(q.many(entities_array).unwrap()) {
assert_eq!(i, w.0);
}

Expand All @@ -432,7 +432,7 @@ mod tests {
let entities_array: [Entity; ENTITIES_COUNT] =
entities_array.0.clone().try_into().unwrap();

for (i, w) in (0..ENTITIES_COUNT).zip(q.get_many_mut(entities_array).unwrap()) {
for (i, w) in (0..ENTITIES_COUNT).zip(q.many_mut(entities_array).unwrap()) {
assert_eq!(i, w.0);
}

Expand Down
Loading
Loading