String, StringName, NodePath: Debug uses GDScript literals "str", &"name", ^"path"

Author: Bromeon

godot-core/src/builtin/node_path.rs

@@ -4,10 +4,11 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+use std::fmt;
+
 use crate::builtin::GodotString;
 use godot_ffi as sys;
 use godot_ffi::{ffi_methods, GDExtensionTypePtr, GodotFfi};
-use std::fmt::{Display, Formatter, Result as FmtResult};
 
 pub struct NodePath {
     opaque: sys::types::OpaqueNodePath,
@@ -59,10 +60,18 @@ impl From<&str> for NodePath {
     }
 }
 
-impl Display for NodePath {
-    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
+impl fmt::Display for NodePath {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let string = GodotString::from(self);
+        <GodotString as fmt::Display>::fmt(&string, f)
+    }
+}
+
+/// Uses literal syntax from GDScript: `^"node_path"`
+impl fmt::Debug for NodePath {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let string = GodotString::from(self);
-        <GodotString as Display>::fmt(&string, f)
+        write!(f, "^\"{string}\"")
     }
 }
 

godot-core/src/builtin/string.rs

@@ -110,10 +110,11 @@ impl fmt::Display for GodotString {
     }
 }
 
+/// Uses literal syntax from GDScript: `"string"`
 impl fmt::Debug for GodotString {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let s = String::from(self);
-        write!(f, "GodotString(\"{s}\")")
+        write!(f, "\"{s}\"")
     }
 }
 

godot-core/src/builtin/string_name.rs

@@ -8,7 +8,7 @@ use crate::builtin::GodotString;
 use godot_ffi as sys;
 use sys::{ffi_methods, GodotFfi};
 
-use std::fmt::{Debug, Display, Formatter, Result as FmtResult};
+use std::fmt;
 use std::hash::{Hash, Hasher};
 
 #[repr(C)]
@@ -68,21 +68,18 @@ impl Default for StringName {
     }
 }
 
-impl Display for StringName {
-    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
-        // TODO consider using GDScript built-in to_string()
-
+impl fmt::Display for StringName {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         let s = GodotString::from(self);
-        <GodotString as Display>::fmt(&s, f)
+        <GodotString as fmt::Display>::fmt(&s, f)
     }
 }
 
-impl Debug for StringName {
-    fn fmt(&self, f: &mut Formatter<'_>) -> FmtResult {
-        // TODO consider using GDScript built-in to_string()
-
-        let s = GodotString::from(self);
-        <GodotString as Debug>::fmt(&s, f)
+/// Uses literal syntax from GDScript: `&"string_name"`
+impl fmt::Debug for StringName {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let string = GodotString::from(self);
+        write!(f, "&\"{string}\"")
     }
 }