+docs

godot-rust · Nov 24, 2024 · 305c065 · 305c065
1 parent e54a565
commit 305c065
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/godot-core/src/obj/dyn_gd.rs b/godot-core/src/obj/dyn_gd.rs
@@ -6,7 +6,6 @@
  */
 
 use crate::meta;
-use crate::meta::ParamType;
 use crate::obj::guards::DynGdRef;
 use crate::obj::{bounds, AsDyn, Bounds, DynGdMut, Gd, GodotClass, Inherits};
 use std::ops;

diff --git a/godot-core/src/obj/gd.rs b/godot-core/src/obj/gd.rs
@@ -431,6 +431,11 @@ impl<T: GodotClass> Gd<T> {
         }
     }
 
+    /// Upgrades to a `DynGd<T, D>` pointer, enabling the `D` abstraction.
+    ///
+    /// The `D` parameter can typically be inferred when there is a single `AsDyn<...>` implementation for `T`.  \
+    /// Otherwise, use it as `gd.into_dyn::<dyn MyTrait>()`.
+    #[must_use]
     pub fn into_dyn<D>(self) -> DynGd<T, D>
     where
         T: crate::obj::AsDyn<D> + Bounds<Declarer = bounds::DeclUser>,