[Merged by Bors] - Convenience method for entity naming

crates/bevy_core/src/lib.rs

@@ -15,7 +15,8 @@ pub mod prelude {
     //! The Bevy Core Prelude.
     #[doc(hidden)]
     pub use crate::{
-        FrameCountPlugin, Name, TaskPoolOptions, TaskPoolPlugin, TypeRegistrationPlugin,
+        DebugNameQueryExt, FrameCountPlugin, Name, TaskPoolOptions, TaskPoolPlugin,
+        TypeRegistrationPlugin,
     };
 }
 

crates/bevy_core/src/name.rs

@@ -1,4 +1,10 @@
-use bevy_ecs::{component::Component, reflect::ReflectComponent};
+use bevy_ecs::{
+    component::Component,
+    entity::Entity,
+    prelude::Query,
+    query::{ReadOnlyWorldQuery, WorldQuery},
+    reflect::ReflectComponent,
+};
 use bevy_reflect::Reflect;
 use bevy_reflect::{std_traits::ReflectDefault, FromReflect};
 use bevy_utils::AHasher;
@@ -76,6 +82,28 @@ impl std::fmt::Display for Name {
     }
 }
 
+/// An extension trait for [`Query`] for more user friendly debug information about an entity.
+pub trait DebugNameQueryExt<'w, 's, Q: WorldQuery, F: ReadOnlyWorldQuery> {
+    /// Give the [`Name`] of an entity if it has one, otherwise return the [`Entity`].
+    fn debug_name(&'w self, entity: Entity) -> Box<dyn std::fmt::Debug + 'w>
+    where
+        Q::ReadOnly: WorldQuery<Item<'w> = &'w Name>;
+}
+
+impl<'w, 's, Q: WorldQuery, F: ReadOnlyWorldQuery> DebugNameQueryExt<'w, 's, Q, F>
+    for Query<'w, 's, Q, F>
+{
+    fn debug_name(&'w self, entity: Entity) -> Box<dyn std::fmt::Debug + 'w>
+    where
+        Q::ReadOnly: WorldQuery<Item<'w> = &'w Name>,
+    {
+        match self.get(entity).ok() {
+            Some(name) => Box::new(name.as_str()),
+            None => Box::new(entity),
+        }
+    }
+}
+
 /* Conversions from strings */
 
 impl From<&str> for Name {