Added IDictionarySlim<TKey, TValue>.TryRemove API

Microsoft.Toolkit.Mvvm/Messaging/Microsoft.Collections.Extensions/DictionarySlim{TKey,TValue}.cs

@@ -140,7 +140,7 @@ public bool TryGetValue(TKey key, out TValue? value)
         }
 
         /// <inheritdoc/>
-        public bool Remove(TKey key)
+        public TValue? TryRemove(TKey key, out bool success)
         {
             Entry[] entries = this.entries;
             int bucketIndex = key.GetHashCode() & (this.buckets.Length - 1);
@@ -150,6 +150,7 @@ public bool Remove(TKey key)
             while (entryIndex != -1)
             {
                 Entry candidate = entries[entryIndex];
+
                 if (candidate.Key.Equals(key))
                 {
                     if (lastIndex != -1)
@@ -167,14 +168,28 @@ public bool Remove(TKey key)
                     this.freeList = entryIndex;
 
                     this.count--;
-                    return true;
+
+                    success = true;
+
+                    return candidate.Value;
                 }
 
                 lastIndex = entryIndex;
                 entryIndex = candidate.Next;
             }
 
-            return false;
+            success = false;
+
+            return null;
+        }
+
+        /// <inheritdoc/>
+        [MethodImpl(MethodImplOptions.AggressiveInlining)]
+        public bool Remove(TKey key)
+        {
+            _ = TryRemove(key, out bool success);
+
+            return success;
         }
 
         /// <summary>

Microsoft.Toolkit.Mvvm/Messaging/Microsoft.Collections.Extensions/IDictionarySlim{TKey,TValue}.cs

@@ -23,5 +23,13 @@ internal interface IDictionarySlim<in TKey, out TValue> : IDictionarySlim<TKey>
         /// <returns>The returned value.</returns>
         /// <exception cref="ArgumentException">Thrown if the key wasn't present.</exception>
         TValue this[TKey key] { get; }
+
+        /// <summary>
+        /// Tries to remove a value with a specified key.
+        /// </summary>
+        /// <param name="key">The key of the value to remove.</param>
+        /// <param name="success">Whether or not the key was present.</param>
+        /// <returns>The removed value, if it was present.</returns>
+        TValue? TryRemove(TKey key, out bool success);
     }
 }