Merge pull request #586 from godot-rust/qol/string-name-ord

Add `StringName::transient_ord()`

Author: Bromeon

godot-codegen/src/models/domain.rs

@@ -331,18 +331,6 @@ pub trait Function: fmt::Display {
     }
 }
 
-#[deprecated]
-struct FnSignature<'a> {
-    function_name: &'a str,
-    surrounding_class: Option<&'a TyName>, // None if global function
-    is_private: bool,
-    is_virtual: bool,
-    is_vararg: bool,
-    qualifier: FnQualifier,
-    params: Vec<FnParam>,
-    return_value: FnReturn,
-}
-
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 
 pub struct UtilityFunction {

godot-codegen/src/models/domain_mapping.rs

@@ -343,7 +343,6 @@ impl BuiltinMethod {
             .as_deref()
             .map(JsonMethodReturn::from_type_no_meta);
 
-        // use BuiltinMethod, but adopt values from above FnSignature expr
         Some(Self {
             common: FunctionCommon {
                 // Fill in these fields

godot-core/src/builtin/callable.rs

@@ -271,15 +271,16 @@ impl Callable {
 
 impl_builtin_traits! {
     for Callable {
-        // Currently no Default::default() to encourage explicit valid initialization.
-        //Default => callable_construct_default;
+        // Default is absent by design, to encourage explicit valid initialization.
+
+        Clone => callable_construct_copy;
+        Drop => callable_destroy;
 
         // Equality for custom callables depend on the equality implementation of that custom callable.
         // So we cannot implement `Eq` here and be confident equality will be total for all future custom callables.
-        // Godot does not define a less-than operator, so there is no `PartialOrd`.
         PartialEq => callable_operator_equal;
-        Clone => callable_construct_copy;
-        Drop => callable_destroy;
+        // Godot does not define a less-than operator, so there is no `PartialOrd`.
+        // Hash could be added, but without Eq it's not that useful; wait for actual use cases.
     }
 }
 

godot-core/src/builtin/dictionary.rs

@@ -297,6 +297,8 @@ impl_builtin_traits! {
         Default => dictionary_construct_default;
         Drop => dictionary_destroy;
         PartialEq => dictionary_operator_equal;
+        // No < operator for dictionaries.
+        // Hash could be added, but without Eq it's not that useful.
     }
 }
 
@@ -305,6 +307,7 @@ impl fmt::Debug for Dictionary {
         write!(f, "{:?}", self.to_variant().stringify())
     }
 }
+
 impl fmt::Display for Dictionary {
     /// Formats `Dictionary` to match Godot's string representation.
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {

godot-core/src/builtin/mod.rs

@@ -36,26 +36,35 @@
 // Re-export macros.
 pub use crate::{array, dict, real, reals, varray};
 
-pub use aabb::*;
-pub use array_inner::{Array, VariantArray};
-pub use basis::*;
-pub use callable::*;
-pub use color::*;
-pub use dictionary_inner::Dictionary;
-pub use packed_array::*;
-pub use plane::*;
-pub use projection::*;
-pub use quaternion::*;
-pub use real_inner::*;
-pub use rect2::*;
-pub use rect2i::*;
-pub use rid::*;
-pub use signal::*;
-pub use string::*;
-pub use transform2d::*;
-pub use transform3d::*;
-pub use variant::*;
-pub use vectors::*;
+#[doc(hidden)]
+pub mod __prelude_reexport {
+    use super::*;
+
+    pub use aabb::*;
+    pub use array_inner::{Array, VariantArray};
+    pub use basis::*;
+    pub use callable::*;
+    pub use color::*;
+    pub use dictionary_inner::Dictionary;
+    pub use packed_array::*;
+    pub use plane::*;
+    pub use projection::*;
+    pub use quaternion::*;
+    pub use real_inner::*;
+    pub use rect2::*;
+    pub use rect2i::*;
+    pub use rid::*;
+    pub use signal::*;
+    pub use string::{GString, NodePath, StringName};
+    pub use transform2d::*;
+    pub use transform3d::*;
+    pub use variant::*;
+    pub use vectors::*;
+
+    pub use crate::{array, dict, real, reals, varray};
+}
+
+pub use __prelude_reexport::*;
 
 /// Meta-information about variant types, properties and class names.
 pub mod meta;
@@ -73,6 +82,11 @@ pub mod dictionary {
     pub use super::dictionary_inner::{Iter, Keys, TypedIter, TypedKeys};
 }
 
+/// Specialized types related to Godot's various string implementations.
+pub mod strings {
+    pub use super::string::TransientStringNameOrd;
+}
+
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Implementation
 
@@ -145,6 +159,7 @@ pub enum RectSide {
 }
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
+// #[test] utils for serde
 
 #[cfg(all(test, feature = "serde"))]
 pub(crate) mod test_utils {

godot-core/src/builtin/plane.rs

@@ -299,6 +299,9 @@ impl std::fmt::Display for Plane {
     }
 }
 
+// ----------------------------------------------------------------------------------------------------------------------------------------------
+// Tests
+
 #[cfg(test)]
 mod test {
     use crate::assert_eq_approx;