[Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. #6214

targrub · 2022-10-09T22:21:14Z

Objective

Adding Debug implementations for App, Stage, Schedule, Query, QueryState.
Fixes Better Debug support for Bevy ECS #1130.

Solution

Implemented std::fmt::Debug for a number of structures.

Changelog

Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor.

Opinions are sure to differ as to what information to provide in a Debug implementation. Best guess was taken for this initial version for these structures.

crates/bevy_app/src/app.rs

crates/bevy_ecs/src/schedule/run_criteria.rs

crates/bevy_ecs/src/schedule/system_container.rs

Added a copy of the Debug of App for SubApps. Removed newline in SystemContainer Debug. Added more Debug info for Systems with run criteria.

targrub · 2022-10-10T02:10:35Z

There is something odd about the output for Schedule.stages, and it probably is due to this downcasting in impl Debug for dyn Stage: self.as_any().downcast_ref::<SystemStage>(). Part of the output will be something like this:

 CoreStage::Last: Stage Some(SystemStage: {

Note the "Some(". Ideas?

harudagondi · 2022-10-10T06:32:34Z

Note the "Some(". Ideas?

downcast_ref returns Option<&T>. I'm not familiar with Stage and SystemStage, but if Stage is only impl for SystemStage and nothing else, then I think it's safe to unwrap it.

crates/bevy_ecs/src/schedule/stage.rs

alice-i-cecile

I'm happy with this now. Great work.

bors r+

…ate, etc. (#6214) # Objective - Adding Debug implementations for App, Stage, Schedule, Query, QueryState. - Fixes #1130. ## Solution - Implemented std::fmt::Debug for a number of structures. --- ## Changelog Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor. Opinions are sure to differ as to what information to provide in a Debug implementation. Best guess was taken for this initial version for these structures. Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>

bors · 2022-10-10T19:41:56Z

Build failed:

check-compiles

alice-i-cecile · 2022-10-10T20:59:21Z

bors retry

…ate, etc. (#6214) # Objective - Adding Debug implementations for App, Stage, Schedule, Query, QueryState. - Fixes #1130. ## Solution - Implemented std::fmt::Debug for a number of structures. --- ## Changelog Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor. Opinions are sure to differ as to what information to provide in a Debug implementation. Best guess was taken for this initial version for these structures. Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>

bors · 2022-10-10T21:14:53Z

Pull request successfully merged into main.

Build succeeded:

…ate, etc. (bevyengine#6214) # Objective - Adding Debug implementations for App, Stage, Schedule, Query, QueryState. - Fixes bevyengine#1130. ## Solution - Implemented std::fmt::Debug for a number of structures. --- ## Changelog Also added Debug implementations for ParallelSystemExecutor, SingleThreadedExecutor, various RunCriteria structures, SystemContainer, and SystemDescriptor. Opinions are sure to differ as to what information to provide in a Debug implementation. Best guess was taken for this initial version for these structures. Co-authored-by: targrub <62773321+targrub@users.noreply.github.com>

targrub and others added 6 commits October 9, 2022 15:17

Implementations of Debug for App, System, Stage, Schedule, and related.

8258d56

Added Debug trait to Query, QueryState

483d7c3

Revert some changes to simplify the overall changes

22feb57

Merge branch 'bevyengine:main' into Issue1130

0bc5d24

Formatting change.

76adb7c

Merge remote-tracking branch 'origin/Issue1130' into Issue1130

8fc30bc

alice-i-cecile added A-ECS Entities, components, systems, and events C-Usability A simple quality-of-life change that makes Bevy easier to use labels Oct 9, 2022

alice-i-cecile reviewed Oct 9, 2022

View reviewed changes

crates/bevy_app/src/app.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Oct 9, 2022

View reviewed changes

crates/bevy_ecs/src/schedule/run_criteria.rs Outdated Show resolved Hide resolved

alice-i-cecile reviewed Oct 9, 2022

View reviewed changes

crates/bevy_ecs/src/schedule/system_container.rs Outdated Show resolved Hide resolved

targrub added 2 commits October 9, 2022 21:01

Debug adjustments.

ec35a1e

Added a copy of the Debug of App for SubApps. Removed newline in SystemContainer Debug. Added more Debug info for Systems with run criteria.

Custom Debug for SystemStage writing Systems on new lines if multiple.

96f7bcc

harudagondi approved these changes Oct 10, 2022

View reviewed changes

crates/bevy_ecs/src/schedule/stage.rs Outdated Show resolved Hide resolved

Handle downcasting of dyn Stage properly.

b319293

alice-i-cecile approved these changes Oct 10, 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 Oct 10, 2022

targrub and others added 2 commits October 10, 2022 16:29

Merge branch 'bevyengine:main' into Issue1130

1a040c8

Added Debug for new enum AmbiguityDetection.

0aa4438

bors bot changed the title ~~Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc.~~ [Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. Oct 10, 2022

bors bot closed this Oct 10, 2022

targrub deleted the Issue1130 branch October 10, 2022 21:22

mockersf added the hacktoberfest-accepted A PR that was accepted for Hacktoberfest, an annual open source event label Oct 10, 2022

BoxyUwU mentioned this pull request Jan 9, 2023

Model world borrow in Query more accurately #5588

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. #6214

[Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. #6214

targrub commented Oct 9, 2022

targrub commented Oct 10, 2022

harudagondi commented Oct 10, 2022

alice-i-cecile left a comment

bors bot commented Oct 10, 2022

alice-i-cecile commented Oct 10, 2022

bors bot commented Oct 10, 2022

[Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. #6214

[Merged by Bors] - Adding Debug implementations for App, Stage, Schedule, Query, QueryState, etc. #6214

Conversation

targrub commented Oct 9, 2022

Objective

Solution

Changelog

targrub commented Oct 10, 2022

harudagondi commented Oct 10, 2022

alice-i-cecile left a comment

Choose a reason for hiding this comment

bors bot commented Oct 10, 2022

alice-i-cecile commented Oct 10, 2022

bors bot commented Oct 10, 2022