Add `QueryState::get_single_unchecked_manual` and its family #3159

2ne1ugly · 2021-11-21T06:00:03Z

Hey people! This is my first PR to bevy. Definitely this issue helped me get some insights to bevy ecs.
I hope I followed the correct conventions! Tho, don't mind to correct them :)

Objective

Fixes Add single() to QueryState #3156
add #[inline] to single related functions so that they matches with other function defs
elide one lifetime in Query::single, Query::get_single

Solution

added functions to QueryState
- get_single_unchecked_manual
- get_single_unchecked
- get_single
- get_single_mut
- single
- single_mut
make Query::get_single use QueryState::get_single_unchecked_manual
added #[inline] & elided lifetimes
change #[derive(Debug, Error)] to #[derive(Error, Debug)] because it tilts me

alice-i-cecile

Awesome first PR, thank you! I have not a single nit to pick.

Other than the broken import that CI caught of course :p You should check out https://github.com/bevyengine/bevy/blob/main/CONTRIBUTING.md if you haven't yet, and welcome aboard :)

MinerSebas

This PR needs to be updated due to the changes from #2305

crates/bevy_ecs/src/system/query.rs

Shatur · 2022-03-10T22:08:31Z

@2ne1ugly could you rebase the PR ?

2ne1ugly · 2022-03-13T07:17:34Z

@2ne1ugly could you rebase the PR ?

Done

Shatur · 2022-03-13T09:13:53Z

Thanks! Cart said that he will back to this in about a week.

alice-i-cecile · 2022-04-04T20:42:10Z

I just double-checked, and the lifetimes here appear to be correct: compare to

bevy/crates/bevy_ecs/src/query/state.rs

Line 139 in d9d2fb6

pub fn get<'w, 's>(

crates/bevy_ecs/src/query/state.rs

crates/bevy_ecs/src/system/query.rs

Fix formatting

2ne1ugly · 2022-04-24T12:08:54Z

Sorry for being a bit late! I'm doing unversity on weekends and it's the mid-term season.
Not sure about the check-markdown-links CI failure 🤔 Should I leave it be? It looks like it's happening to other branches too.

alice-i-cecile · 2022-05-06T19:20:50Z

@Shatur @MinerSebas can I get another review on this?

alice-i-cecile · 2022-05-25T22:07:38Z

bors try

bors · 2022-05-25T22:08:28Z

try

Build failed:

build-wasm (stable, ubuntu-latest)

alice-i-cecile · 2022-05-25T22:09:25Z

@2ne1ugly can you please rebase? I think the CI failure is spurious based on an old breakage we had.

alice-i-cecile · 2022-05-25T22:59:45Z

Currently broken; the lifetimes must be fixed. Once this compiles again, I'm happy to slap the Ready-For-Final-Review label back on.

2ne1ugly · 2022-05-26T12:15:40Z

Currently broken; the lifetimes must be fixed. Once this compiles again, I'm happy to slap the Ready-For-Final-Review label back on.

I'm on vacation rn so I won't be able to help until june 6th. If we need this earlier, feel free to do it for me :)

Shatur · 2022-05-26T12:17:11Z

I'm on vacation rn so I won't be able to help until june 6th. If we need this earlier, feel free to do it for me :)

No problem, fixed it: #4841.

# Objective - Rebase of #3159. - Fixes #3156 - add #[inline] to single related functions so that they matches with other function defs ## Solution * added functions to QueryState * get_single_unchecked_manual * get_single_unchecked * get_single * get_single_mut * single * single_mut * make Query::get_single use QueryState::get_single_unchecked_manual * added #[inline] --- ## Changelog ### Added Functions `QueryState::single`, `QueryState::get_single`, `QueryState::single_mut`, `QueryState::get_single_mut`, `QueryState::get_single_unchecked`, `QueryState::get_single_unchecked_manual`. ### Changed `QuerySingleError` is now in the `state` module. ## Migration Guide Change `query::QuerySingleError` to `state::QuerySingleError` Co-authored-by: 2ne1ugly <chattermin@gmail.com> Co-authored-by: 2ne1ugly <47616772+2ne1ugly@users.noreply.github.com>

james7132 · 2022-05-31T06:33:37Z

As #4841 has been merged, closing this one.

…e#4841) # Objective - Rebase of bevyengine#3159. - Fixes bevyengine#3156 - add #[inline] to single related functions so that they matches with other function defs ## Solution * added functions to QueryState * get_single_unchecked_manual * get_single_unchecked * get_single * get_single_mut * single * single_mut * make Query::get_single use QueryState::get_single_unchecked_manual * added #[inline] --- ## Changelog ### Added Functions `QueryState::single`, `QueryState::get_single`, `QueryState::single_mut`, `QueryState::get_single_mut`, `QueryState::get_single_unchecked`, `QueryState::get_single_unchecked_manual`. ### Changed `QuerySingleError` is now in the `state` module. ## Migration Guide Change `query::QuerySingleError` to `state::QuerySingleError` Co-authored-by: 2ne1ugly <chattermin@gmail.com> Co-authored-by: 2ne1ugly <47616772+2ne1ugly@users.noreply.github.com>

Move internals to state and make some helpers

6a30897

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Nov 21, 2021

2ne1ugly added 2 commits November 21, 2021 15:01

fix one log

562553b

fix import error

f07ef31

alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A targeted quality-of-life change that makes Bevy easier to use S-Needs-Review and removed S-Needs-Triage This issue needs to be labelled labels Nov 21, 2021

apply formatting this time

bded26b

alice-i-cecile approved these changes Nov 21, 2021

View reviewed changes

fix example

8237582

MinerSebas suggested changes Dec 10, 2021

View reviewed changes

crates/bevy_ecs/src/system/query.rs Outdated Show resolved Hide resolved

crates/bevy_ecs/src/system/query.rs Outdated Show resolved Hide resolved

cart removed the S-Needs-Review label Dec 16, 2021

2ne1ugly and others added 9 commits December 19, 2021 22:07

Merge branch 'main' into query-state-single

35a6412

Directly use read only fetch

c064abd

Properly close braces

415a2ed

Add comma

a575011

Add type param

b17eb7e

format

2f2d37f

fomat one last time

f5c0cb5

fix docs

76b2148

Copy docs over

8df9823

alice-i-cecile approved these changes Dec 24, 2021

View reviewed changes

sarkahn mentioned this pull request Feb 18, 2022

Add single/single_mut funcs to QueryState #3977

Closed

Merge branch 'main' into query-state-single

6bfc41b

cart added this to the Bevy 0.7 milestone Apr 4, 2022

cart reviewed Apr 7, 2022

View reviewed changes

crates/bevy_ecs/src/query/state.rs Show resolved Hide resolved

crates/bevy_ecs/src/query/state.rs Show resolved Hide resolved

crates/bevy_ecs/src/query/state.rs Outdated Show resolved Hide resolved

crates/bevy_ecs/src/system/query.rs Outdated Show resolved Hide resolved

2ne1ugly added 3 commits April 24, 2022 20:37

Merge branch 'main' into query-state-single

caf2c05

Update state.rs

4bfd01b

Update state.rs

83fe39c

Fix formatting

alice-i-cecile modified the milestones: Bevy 0.7, Bevy 0.8 Apr 25, 2022

Merge remote-tracking branch 'origin/main' into query-state-single

c7da38f

alice-i-cecile approved these changes May 6, 2022

View reviewed changes

Shatur approved these changes May 25, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 25, 2022

bors bot added a commit that referenced this pull request May 25, 2022

Try #3159:

aa7d84c

Shatur mentioned this pull request May 25, 2022

[Merged by Bors] - Add QueryState::get_single_unchecked_manual and its family #4841

Closed

alice-i-cecile removed the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label May 25, 2022

james7132 closed this May 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `QueryState::get_single_unchecked_manual` and its family #3159

Add `QueryState::get_single_unchecked_manual` and its family #3159

2ne1ugly commented Nov 21, 2021

alice-i-cecile left a comment •

edited

Loading

MinerSebas left a comment

Shatur commented Mar 10, 2022

2ne1ugly commented Mar 13, 2022

Shatur commented Mar 13, 2022

alice-i-cecile commented Apr 4, 2022

2ne1ugly commented Apr 24, 2022 •

edited

Loading

alice-i-cecile commented May 6, 2022

alice-i-cecile commented May 25, 2022

bors bot commented May 25, 2022

alice-i-cecile commented May 25, 2022

alice-i-cecile commented May 25, 2022

2ne1ugly commented May 26, 2022

Shatur commented May 26, 2022

james7132 commented May 31, 2022

Add QueryState::get_single_unchecked_manual and its family #3159

Add QueryState::get_single_unchecked_manual and its family #3159

Conversation

2ne1ugly commented Nov 21, 2021

Objective

Solution

alice-i-cecile left a comment • edited Loading

Choose a reason for hiding this comment

MinerSebas left a comment

Choose a reason for hiding this comment

Shatur commented Mar 10, 2022

2ne1ugly commented Mar 13, 2022

Shatur commented Mar 13, 2022

alice-i-cecile commented Apr 4, 2022

2ne1ugly commented Apr 24, 2022 • edited Loading

alice-i-cecile commented May 6, 2022

alice-i-cecile commented May 25, 2022

bors bot commented May 25, 2022

try

alice-i-cecile commented May 25, 2022

alice-i-cecile commented May 25, 2022

2ne1ugly commented May 26, 2022

Shatur commented May 26, 2022

james7132 commented May 31, 2022

Add `QueryState::get_single_unchecked_manual` and its family #3159

Add `QueryState::get_single_unchecked_manual` and its family #3159

alice-i-cecile left a comment •

edited

Loading

2ne1ugly commented Apr 24, 2022 •

edited

Loading