Variant, String: rename forget() -> leak()

Consistent with standard Vec::leak(), Box::leak() etc.

Author: Bromeon

gdnative-core/src/core_types/string.rs

@@ -237,15 +237,14 @@ impl GodotString {
         Self(unsafe { (get_api().godot_string_format)(&self.0, &values.0) })
     }
 
-    /// Returns the internal ffi representation of the string and consumes
-    /// the rust object without running the destructor.
+    /// Returns the internal FFI representation of the string and consumes
+    /// the Rust object without running the destructor.
     ///
-    /// This should be only used when certain that the receiving side is
-    /// responsible for running the destructor for the object, otherwise
-    /// it is leaked.
+    /// The returned object has no `Drop` implementation. The caller is
+    /// responsible of manually ensuring destruction.
     #[doc(hidden)]
     #[inline]
-    pub fn forget(self) -> sys::godot_string {
+    pub fn leak(self) -> sys::godot_string {
         let v = self.0;
         forget(self);
         v
@@ -285,7 +284,7 @@ impl GodotString {
     pub fn clone_from_sys(sys: sys::godot_string) -> Self {
         let sys_string = GodotString(sys);
         let this = sys_string.clone();
-        sys_string.forget();
+        sys_string.leak();
         this
     }
 

gdnative-core/src/core_types/variant.rs

@@ -524,15 +524,14 @@ impl Variant {
         unsafe { &mut *(ptr as *mut variant::Variant) }
     }
 
-    /// Returns the internal ffi representation of the variant and consumes
-    /// the rust object without running the destructor.
+    /// Returns the internal FFI representation of the variant and consumes
+    /// the Rust object without running the destructor.
     ///
-    /// This should be only used when certain that the receiving side is
-    /// responsible for running the destructor for the object, otherwise
-    /// it is leaked.
+    /// The returned object has no `Drop` implementation. The caller is
+    /// responsible of manually ensuring destruction.
     #[inline]
     #[doc(hidden)]
-    pub fn forget(self) -> sys::godot_variant {
+    pub fn leak(self) -> sys::godot_variant {
         let v = self.0;
         forget(self);
         v

gdnative-core/src/export/method.rs

@@ -549,7 +549,7 @@ unsafe extern "C" fn method_wrapper<C: NativeClass, F: Method<C>>(
                 C::class_name(),
             ),
         );
-        return Variant::nil().forget();
+        return Variant::nil().leak();
     }
 
     let this = match std::ptr::NonNull::new(this) {
@@ -562,7 +562,7 @@ unsafe extern "C" fn method_wrapper<C: NativeClass, F: Method<C>>(
                     C::class_name(),
                 ),
             );
-            return Variant::nil().forget();
+            return Variant::nil().leak();
         }
     };
 
@@ -586,7 +586,7 @@ unsafe extern "C" fn method_wrapper<C: NativeClass, F: Method<C>>(
             );
             Variant::nil()
         })
-        .forget()
+        .leak()
 }
 
 unsafe extern "C" fn free_func<F>(method_data: *mut libc::c_void) {

gdnative-core/src/export/property/accessor.rs

@@ -296,7 +296,7 @@ where
                     "gdnative-core: user data pointer for {} is null (did the constructor fail?)",
                     C::class_name(),
                 );
-                return Variant::nil().forget();
+                return Variant::nil().leak();
             }
 
             let this = match NonNull::new(this) {
@@ -306,7 +306,7 @@ where
                         "gdnative-core: owner pointer for {} is null",
                         C::class_name(),
                     );
-                    return Variant::nil().forget();
+                    return Variant::nil().leak();
                 }
             };
 
@@ -316,17 +316,17 @@ where
                 let func = &*(method as *const F);
 
                 match <(SelfArg, RetKind)>::map_get(&user_data, func, owner) {
-                    Ok(variant) => variant.forget(),
+                    Ok(variant) => variant.leak(),
                     Err(err) => {
                         godot_error!("gdnative-core: cannot call property getter: {:?}", err);
-                        Variant::nil().forget()
+                        Variant::nil().leak()
                     }
                 }
             });
 
             result.unwrap_or_else(|_| {
                 godot_error!("gdnative-core: property getter panicked (check stderr for output)");
-                Variant::nil().forget()
+                Variant::nil().leak()
             })
         }
         get.get_func = Some(invoke::<SelfArg, RetKind, C, F, T>);

gdnative-core/src/export/property/invalid_accessor.rs

@@ -70,7 +70,7 @@ extern "C" fn invalid_getter(
         property_name,
         class_name
     );
-    Variant::nil().forget()
+    Variant::nil().leak()
 }
 
 extern "C" fn invalid_free_func(data: *mut libc::c_void) {

test/src/lib.rs

@@ -75,7 +75,7 @@ pub extern "C" fn run_tests(
     status &= test_variant_ops::run_tests();
     status &= test_vararray_return::run_tests();
 
-    gdnative::core_types::Variant::new(status).forget()
+    gdnative::core_types::Variant::new(status).leak()
 }
 
 fn test_underscore_method_binding() -> bool {