Merge pull request #1184 from godot-rust/qol/prepare-v0.3

Improve signal/async docs; MSRV 1.85 -> 1.87

Author: Bromeon

.github/workflows/full-ci.yml

@@ -145,7 +145,7 @@ jobs:
 
           - name: linux
             os: ubuntu-22.04
-            rust-toolchain: "1.85"
+            rust-toolchain: "1.87"
             rust-special: -msrv
 
     steps:

.github/workflows/update-docs.yml

@@ -19,7 +19,7 @@ on:
 
 env:
   # Keep this a variable for easy search&replace.
-  MSRV: 1.85
+  MSRV: 1.87
 
 jobs:
   notify-docs:

Changelog.md

@@ -10,10 +10,116 @@ Cutting-edge API docs of the `master` branch are available [here](https://godot-
 
 ## Quick navigation
 
+- [v0.3.0](#v030)
 - [v0.2.0](#v020), [v0.2.1](#v021), [v0.2.2](#v022), [v0.2.3](#v023), [v0.2.4](#v024)
 - [v0.1.1](#v011), [v0.1.2](#v012), [v0.1.3](#v013)
 
 
+## [v0.3.0](https://docs.rs/godot/0.3.0)
+
+_31 May 2025_
+
+See [devlog article](https://godot-rust.github.io/dev/may-2025-update) for highlights.
+
+### 🌻 Features
+
+- Godot 4.4 support ([#1065](https://github.com/godot-rust/gdext/pull/1065))
+- Type-safe signals
+  - 🌊 User-defined signals ([#1000](https://github.com/godot-rust/gdext/pull/1000))
+  - Explicit signal visibility ([#1075](https://github.com/godot-rust/gdext/pull/1075))
+  - Type-safe signals for engine classes ([#1111](https://github.com/godot-rust/gdext/pull/1111))
+  - Inherited typed signals ([#1134](https://github.com/godot-rust/gdext/pull/1134))
+  - `emit()` now available on inherited symbols + smaller cleanups ([#1135](https://github.com/godot-rust/gdext/pull/1135))
+  - User classes expose typed-signal API even without `#[signal]` ([#1146](https://github.com/godot-rust/gdext/pull/1146))
+  - Generated `emit()` functions now take `impl AsArg<T>` ([#1150](https://github.com/godot-rust/gdext/pull/1150))
+  - Simplify `connect*` usage ([#1152](https://github.com/godot-rust/gdext/pull/1152))
+  - Clean up `ConnectBuilder` and some other signal APIs ([#1171](https://github.com/godot-rust/gdext/pull/1171))
+  - `ConnectBuilder::connect_*_gd()` takes `Gd` instead of `&mut Gd` ([#1175](https://github.com/godot-rust/gdext/pull/1175))
+  - Replace macro approach with indirect trait ([#1179](https://github.com/godot-rust/gdext/pull/1179))
+- Async/await
+  - Async Signals ([#1043](https://github.com/godot-rust/gdext/pull/1043))
+  - Allow `Gd<T>` to be passed as a parameter in async signals ([#1091](https://github.com/godot-rust/gdext/pull/1091))
+  - Prevent `signal_future_send_arg_no_panic` test from panicking ([#1137](https://github.com/godot-rust/gdext/pull/1137))
+  - Itest runner must call `on_finished` deferred ([#1095](https://github.com/godot-rust/gdext/pull/1095))
+  - Impl `DynamicSend` for `Array<T>` ([#1122](https://github.com/godot-rust/gdext/pull/1122))
+- Registration
+  - 🌊 Add `OnEditor<T>`, remove `impl<T> Export for Gd<T>` and `DynGd<T, D>` ([#1051](https://github.com/godot-rust/gdext/pull/1051), [#1079](https://github.com/godot-rust/gdext/pull/1079))
+  - Add `OnReady::from_loaded()` + `#[init(load = "PATH")]` ([#1083](https://github.com/godot-rust/gdext/pull/1083))
+  - Add support for `@experimental` and `@deprecated` attributes for user-generated docs ([#1114](https://github.com/godot-rust/gdext/pull/1114))
+- Builtin types
+  - Callables to builtin methods; `Array::bsearch_by, sort_unstable_by` ([#1064](https://github.com/godot-rust/gdext/pull/1064))
+  - `GString`, `StringName`: add conversions from bytes and C-strings ([#1062](https://github.com/godot-rust/gdext/pull/1062))
+  - `Array`, `Dictionary`: add `into_read_only()` + `is_read_only()` ([#1096](https://github.com/godot-rust/gdext/pull/1096))
+- Interface traits
+  - Virtual methods can become optional/required/removed in derived classes ([#1136](https://github.com/godot-rust/gdext/pull/1136))
+  - 🌊 Final and non-instantiable classes ([#1162](https://github.com/godot-rust/gdext/pull/1162))
+  - 🌊 Final classes no longer have a `I*` interface trait ([#1182](https://github.com/godot-rust/gdext/pull/1182))
+- Support `f32` directly in `process` and `physics_process` ([#1110](https://github.com/godot-rust/gdext/pull/1110))
+
+### 📈 Performance
+
+- Reduce number of classes in minimal codegen ([#1099](https://github.com/godot-rust/gdext/pull/1099))
+- Decrease `CallError` size from 176 to 8 bytes ([#1167](https://github.com/godot-rust/gdext/pull/1167))
+
+### 🧹 Quality of life
+
+- Usability
+  - Propagate panics in object constructors to `Gd::from_init_fn()`, `new_gd()`, `new_alloc()` ([#1140](https://github.com/godot-rust/gdext/pull/1140))
+  - 🌊 Correct `ConnectFlags` classification (enum -> bitfield) ([#1002](https://github.com/godot-rust/gdext/pull/1002))
+  - Bitfields now have `|=` operator ([#1097](https://github.com/godot-rust/gdext/pull/1097))
+  - Panic handling: thread safety; set hook once and not repeatedly ([#1037](https://github.com/godot-rust/gdext/pull/1037))
+  - Add diagnostic hints for missing `ToGodot`/`FromGodot` traits ([#1084](https://github.com/godot-rust/gdext/pull/1084))
+  - `bind/bind_mut` borrow errors now print previous stacktrace ([#1094](https://github.com/godot-rust/gdext/pull/1094))
+  - Make CollisionShapes `...debug_color` methods available in Release builds ([#1149](https://github.com/godot-rust/gdext/pull/1149))
+  - 🌊 Add `_rawptr` suffix to all unsafe virtual functions ([#1174](https://github.com/godot-rust/gdext/pull/1174))
+  - 🌊 Remove deprecated symbols for v0.3 ([#1160](https://github.com/godot-rust/gdext/pull/1160))
+- Refactoring
+  - Experiment with splitting up signature differently ([#1042](https://github.com/godot-rust/gdext/pull/1042))
+  - XML doc generation: code cleanup ([#1077](https://github.com/godot-rust/gdext/pull/1077))
+  - `GodotFfi::variant_type` can be constant ([#1090](https://github.com/godot-rust/gdext/pull/1090))
+  - Refactor parsing of `#[godot_api]` inner attributes ([#1154](https://github.com/godot-rust/gdext/pull/1154))
+  - Adjust test to account for `Node::set_name()` change (`String` -> `StringName`) ([#1153](https://github.com/godot-rust/gdext/pull/1153))
+- Dependencies, project structure, tooling
+  - Move examples out of repository ([#1085](https://github.com/godot-rust/gdext/pull/1085))
+  - Remove paste, simplify plugin macros ([#1069](https://github.com/godot-rust/gdext/pull/1069))
+  - 🌊 Bump MSRV from 1.80 to 1.87 ([#1076](https://github.com/godot-rust/gdext/pull/1076), [#1184](https://github.com/godot-rust/gdext/pull/1184))
+  - Validate that `api-custom` is run for Godot Debug binary ([#1071](https://github.com/godot-rust/gdext/pull/1071))
+  - Centralize + update dependencies in workspace `Cargo.toml` ([#1127](https://github.com/godot-rust/gdext/pull/1127))
+  - 🌊 Reduce number of classes in minimal codegen ([#1099](https://github.com/godot-rust/gdext/pull/1099))
+  - Post `Rust 1.86` update: apply clippy lints ([#1115](https://github.com/godot-rust/gdext/pull/1115))
+  - Move `itest` default feature `codegen-full` into build script ([#1100](https://github.com/godot-rust/gdext/pull/1100))
+
+### 🛠️ Bugfixes
+
+- WebAssembly
+  - Wasm threading fixes ([#1093](https://github.com/godot-rust/gdext/pull/1093))
+  - Remove `gensym`, fix Wasm class registration ([#1092](https://github.com/godot-rust/gdext/pull/1092))
+  - Undo Wasm threading fix on panic context tracking ([#1107](https://github.com/godot-rust/gdext/pull/1107))
+- Editor integration
+  - Fix editor docs not generating when class itself is undocumented ([#1089](https://github.com/godot-rust/gdext/pull/1089))
+  - Fix crash related to adding `EditorPlugin` to the editor before all the classes are registered ([#1138](https://github.com/godot-rust/gdext/pull/1138))
+- Misc
+  - 🌊 `Callable::from_local_static()` now requires Godot 4.4+ ([#1029](https://github.com/godot-rust/gdext/pull/1029))
+  - Masked enums can now be constructed from integers ([#1106](https://github.com/godot-rust/gdext/pull/1106))
+  - Properly set `GDExtensionBool` is_valid to true in `to_string` function ([#1145](https://github.com/godot-rust/gdext/pull/1145))
+  - Virtual dispatch: fix incorrect matching of renamed methods ([#1173](https://github.com/godot-rust/gdext/pull/1173))
+- Tooling workarounds
+  - Release job in minimal CI; temporarily work around Godot blocker ([#1143](https://github.com/godot-rust/gdext/pull/1143))
+  - Work around `OpenXR*` APIs wrongly exposed in release; wider release checks in CI ([#1070](https://github.com/godot-rust/gdext/pull/1070))
+  - Work around `ResourceDeepDuplicateMode` wrongly marked as an global enum in `extension_api.json` ([#1180](https://github.com/godot-rust/gdext/pull/1180))
+
+### 📚 Documentation
+
+- Move builtin API design to `__docs` module ([#1063](https://github.com/godot-rust/gdext/pull/1063))
+- Regression test for checking if `RustCallable` is connected to signal ([#1068](https://github.com/godot-rust/gdext/pull/1068))
+- Describe semantics of `base_mut()` in docs ([#1103](https://github.com/godot-rust/gdext/pull/1103))
+- Document `DynGd<_, D>` type inference ([#1142](https://github.com/godot-rust/gdext/pull/1142))
+- `#[derive(GodotClass)]`, `#[godot_api]` docs: replace table of contents with sidebar ([#1155](https://github.com/godot-rust/gdext/pull/1155))
+- Add `rustc-args` to `package.metadata.docs.rs` ([#1169](https://github.com/godot-rust/gdext/pull/1169))
+- Document runtime class in editor requirement ([#1168](https://github.com/godot-rust/gdext/pull/1168))
+- Improve signal/async docs ([#1184](https://github.com/godot-rust/gdext/pull/1184))
+
+
 ## [v0.2.4](https://docs.rs/godot/0.2.4)
 
 _24 February 2025_

godot-bindings/Cargo.toml

@@ -2,7 +2,7 @@
 name = "godot-bindings"
 version = "0.2.4"
 edition = "2021"
-rust-version = "1.85"
+rust-version = "1.87"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "ffi", "sys"]
 categories = ["game-engines", "graphics"]

godot-cell/Cargo.toml

@@ -2,7 +2,7 @@
 name = "godot-cell"
 version = "0.2.4"
 edition = "2021"
-rust-version = "1.85"
+rust-version = "1.87"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "ffi"]
 categories = ["game-engines", "graphics"]

godot-codegen/Cargo.toml

@@ -2,7 +2,7 @@
 name = "godot-codegen"
 version = "0.2.4"
 edition = "2021"
-rust-version = "1.85"
+rust-version = "1.87"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "codegen"]
 categories = ["game-engines", "graphics"]

godot-core/Cargo.toml

@@ -2,7 +2,7 @@
 name = "godot-core"
 version = "0.2.4"
 edition = "2021"
-rust-version = "1.85"
+rust-version = "1.87"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "2d", "3d"] # possibly: "ffi"
 categories = ["game-engines", "graphics"]

godot-core/src/builtin/collections/packed_array.rs

@@ -58,8 +58,7 @@ macro_rules! impl_packed_array {
             $($trait_impls:tt)*
         },
     ) => {
-        #[doc = concat!("Implements Godot's `", stringify!($PackedArray), "` type,")]
-        #[doc = concat!("which is a space-efficient array of `", stringify!($Element), "`s.")]
+        #[doc = concat!("Space-efficient array of [`", stringify!($Element), "`] elements.")]
         ///
         /// Check out the [book](https://godot-rust.github.io/book/godot-api/builtins.html#packed-arrays) for a tutorial on packed arrays.
         ///

godot-core/src/builtin/real.rs

@@ -196,7 +196,7 @@ macro_rules! real {
     }};
 }
 
-/// Array of reals.
+/// Array of [`real`]s.
 ///
 /// The expression has type `[real; N]` where `N` is the number of elements in the array.
 ///

godot-core/src/builtin/signal.rs

@@ -19,12 +19,13 @@ use crate::obj::bounds::DynMemory;
 use crate::obj::{Bounds, Gd, GodotClass, InstanceId};
 use sys::{ffi_methods, GodotFfi};
 
-/// A `Signal` represents a signal of an Object instance in Godot.
+/// Untyped Godot signal.
 ///
-/// Signals are composed of a reference to an `Object` and the name of the signal on this object.
+/// Signals are composed of a pointer to an `Object` and the name of the signal on this object.
 ///
-/// # Godot docs
+/// In Rust, you might want to work with type-safe signals, available under the [`TypedSignal`](crate::registry::signal::TypedSignal) struct.
 ///
+/// # Godot docs
 /// [`Signal` (stable)](https://docs.godotengine.org/en/stable/classes/class_signal.html)
 pub struct Signal {
     opaque: sys::types::OpaqueSignal,
@@ -75,7 +76,7 @@ impl Signal {
     /// A signal can only be connected once to the same [`Callable`]. If the signal is already connected,
     /// returns [`Error::ERR_INVALID_PARAMETER`] and
     /// pushes an error message, unless the signal is connected with [`ConnectFlags::REFERENCE_COUNTED`](crate::classes::object::ConnectFlags::REFERENCE_COUNTED).
-    /// To prevent this, use [`Self::is_connected`] first to check for existing connections.
+    /// To prevent this, check for existing connections with [`is_connected()`][Self::is_connected].
     pub fn connect(&self, callable: &Callable, flags: i64) -> Error {
         let error = self.as_inner().connect(callable, flags);
 
@@ -84,7 +85,7 @@ impl Signal {
 
     /// Disconnects this signal from the specified [`Callable`].
     ///
-    /// If the connection does not exist, generates an error. Use [`Self::is_connected`] to make sure that the connection exists.
+    /// If the connection does not exist, generates an error. Use [`is_connected()`](Self::is_connected) to make sure that the connection exists.
     pub fn disconnect(&self, callable: &Callable) {
         self.as_inner().disconnect(callable);
     }