From 8166568976a87b5d5e6ab1d784fd76f25860ab40 Mon Sep 17 00:00:00 2001
From: Raul Santos <raulsntos@gmail.com>
Date: Tue, 31 Jan 2023 04:44:18 +0100
Subject: C#: Implement `IEquatable` in `Rid`

- Implement `IEquatable` interface.
- Implement `==` and `!=` operators.
- Add `IsValid` method.
- Override `Equals` and `GetHashCode`.
- Fix `ToString` to follow Core.
- Sync documentation with Core.
---
 .../mono/glue/GodotSharp/GodotSharp/Core/Rid.cs    | 76 ++++++++++++++++++++--
 1 file changed, 69 insertions(+), 7 deletions(-)

(limited to 'modules/mono')

diff --git a/modules/mono/glue/GodotSharp/GodotSharp/Core/Rid.cs b/modules/mono/glue/GodotSharp/GodotSharp/Core/Rid.cs
index 150eb98fc7..350626389b 100644
--- a/modules/mono/glue/GodotSharp/GodotSharp/Core/Rid.cs
+++ b/modules/mono/glue/GodotSharp/GodotSharp/Core/Rid.cs
@@ -6,13 +6,17 @@ using Godot.NativeInterop;
 namespace Godot
 {
     /// <summary>
-    /// The Rid type is used to access the unique integer ID of a resource.
-    /// They are opaque, which means they do not grant access to the associated
-    /// resource by themselves. They are used by and with the low-level Server
-    /// classes such as <see cref="RenderingServer"/>.
+    /// The RID type is used to access a low-level resource by its unique ID.
+    /// RIDs are opaque, which means they do not grant access to the resource
+    /// by themselves. They are used by the low-level server classes, such as
+    /// <see cref="DisplayServer"/>, <see cref="RenderingServer"/>,
+    /// <see cref="TextServer"/>, etc.
+    ///
+    /// A low-level resource may correspond to a high-level <see cref="Resource"/>,
+    /// such as <see cref="Texture"/> or <see cref="Mesh"/>
     /// </summary>
     [StructLayout(LayoutKind.Sequential)]
-    public readonly struct Rid
+    public readonly struct Rid : IEquatable<Rid>
     {
         private readonly ulong _id; // Default is 0
 
@@ -28,15 +32,73 @@ namespace Godot
             => _id = from is Resource res ? res.GetRid()._id : default;
 
         /// <summary>
-        /// Returns the ID of the referenced resource.
+        /// Returns the ID of the referenced low-level resource.
         /// </summary>
         /// <returns>The ID of the referenced resource.</returns>
         public ulong Id => _id;
 
+        /// <summary>
+        /// Returns <see langword="true"/> if the <see cref="Rid"/> is not <c>0</c>.
+        /// </summary>
+        /// <returns>Whether or not the ID is valid.</returns>
+        public bool IsValid => _id != 0;
+
+        /// <summary>
+        /// Returns <see langword="true"/> if both <see cref="Rid"/>s are equal,
+        /// which means they both refer to the same low-level resource.
+        /// </summary>
+        /// <param name="left">The left RID.</param>
+        /// <param name="right">The right RID.</param>
+        /// <returns>Whether or not the RIDs are equal.</returns>
+        public static bool operator ==(Rid left, Rid right)
+        {
+            return left.Equals(right);
+        }
+
+        /// <summary>
+        /// Returns <see langword="true"/> if the <see cref="Rid"/>s are not equal.
+        /// </summary>
+        /// <param name="left">The left RID.</param>
+        /// <param name="right">The right RID.</param>
+        /// <returns>Whether or not the RIDs are equal.</returns>
+        public static bool operator !=(Rid left, Rid right)
+        {
+            return !left.Equals(right);
+        }
+
+        /// <summary>
+        /// Returns <see langword="true"/> if this RID and <paramref name="obj"/> are equal.
+        /// </summary>
+        /// <param name="obj">The other object to compare.</param>
+        /// <returns>Whether or not the color and the other object are equal.</returns>
+        public override readonly bool Equals(object obj)
+        {
+            return obj is Rid other && Equals(other);
+        }
+
+        /// <summary>
+        /// Returns <see langword="true"/> if the RIDs are equal.
+        /// </summary>
+        /// <param name="other">The other RID.</param>
+        /// <returns>Whether or not the RIDs are equal.</returns>
+        public readonly bool Equals(Rid other)
+        {
+            return _id == other.Id;
+        }
+
+        /// <summary>
+        /// Serves as the hash function for <see cref="Rid"/>.
+        /// </summary>
+        /// <returns>A hash code for this RID.</returns>
+        public override readonly int GetHashCode()
+        {
+            return HashCode.Combine(_id);
+        }
+
         /// <summary>
         /// Converts this <see cref="Rid"/> to a string.
         /// </summary>
         /// <returns>A string representation of this Rid.</returns>
-        public override string ToString() => $"Rid({Id})";
+        public override string ToString() => $"RID({Id})";
     }
 }
-- 
cgit v1.2.3