Nullability: add key constraint (#536)

Author: bitfaster

BitFaster.Caching/Atomic/AsyncAtomicFactory.cs

@@ -14,6 +14,7 @@ namespace BitFaster.Caching.Atomic
     /// <typeparam name="V">The type of the value.</typeparam>
     [DebuggerDisplay("IsValueCreated={IsValueCreated}, Value={ValueIfCreated}")]
     public sealed class AsyncAtomicFactory<K, V> : IEquatable<AsyncAtomicFactory<K, V>>
+        where K : notnull
     {
         private Initializer initializer;
 

BitFaster.Caching/Atomic/AtomicFactory.cs

@@ -14,6 +14,7 @@ namespace BitFaster.Caching.Atomic
     /// <typeparam name="V">The type of the value.</typeparam>
     [DebuggerDisplay("IsValueCreated={IsValueCreated}, Value={ValueIfCreated}")]
     public sealed class AtomicFactory<K, V> : IEquatable<AtomicFactory<K, V>>
+        where K : notnull
     {
         private Initializer initializer;
 

BitFaster.Caching/Atomic/AtomicFactoryAsyncCache.cs

@@ -15,6 +15,7 @@ namespace BitFaster.Caching.Atomic
     [DebuggerTypeProxy(typeof(AtomicFactoryAsyncCache<,>.AsyncCacheDebugView))]
     [DebuggerDisplay("Count = {Count}")]
     public sealed class AtomicFactoryAsyncCache<K, V> : IAsyncCache<K, V>
+        where K : notnull
     {
         private readonly ICache<K, AsyncAtomicFactory<K, V>> cache;
         private readonly Optional<ICacheEvents<K, V>> events;

BitFaster.Caching/Atomic/AtomicFactoryCache.cs

@@ -13,6 +13,7 @@ namespace BitFaster.Caching.Atomic
     [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}")]
     public sealed class AtomicFactoryCache<K, V> : ICache<K, V>
+        where K : notnull
     {
         private readonly ICache<K, AtomicFactory<K, V>> cache;
         private readonly Optional<ICacheEvents<K, V>> events;

BitFaster.Caching/Atomic/AtomicFactoryScopedAsyncCache.cs

@@ -14,7 +14,9 @@ namespace BitFaster.Caching.Atomic
     /// <typeparam name="V">The type of values in the cache.</typeparam>
     [DebuggerTypeProxy(typeof(ScopedAsyncCacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}")]
-    public sealed class AtomicFactoryScopedAsyncCache<K, V> : IScopedAsyncCache<K, V> where V : IDisposable
+    public sealed class AtomicFactoryScopedAsyncCache<K, V> : IScopedAsyncCache<K, V>
+        where K : notnull
+        where V : IDisposable
     {
         private readonly ICache<K, ScopedAsyncAtomicFactory<K, V>> cache;
         private readonly Optional<ICacheEvents<K, Scoped<V>>> events;

BitFaster.Caching/Atomic/AtomicFactoryScopedCache.cs

@@ -13,7 +13,9 @@ namespace BitFaster.Caching.Atomic
     /// <typeparam name="V">The type of values in the cache.</typeparam>
     [DebuggerTypeProxy(typeof(ScopedCacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}")]
-    public sealed class AtomicFactoryScopedCache<K, V> : IScopedCache<K, V> where V : IDisposable
+    public sealed class AtomicFactoryScopedCache<K, V> : IScopedCache<K, V>
+        where K : notnull
+        where V : IDisposable
     {
         private readonly ICache<K, ScopedAtomicFactory<K, V>> cache;
         private readonly Optional<ICacheEvents<K, Scoped<V>>> events;

BitFaster.Caching/Atomic/ConcurrentDictionaryExtensions.cs

@@ -18,6 +18,7 @@ public static class ConcurrentDictionaryExtensions
         /// <param name="valueFactory">The function used to generate a value for the key.</param>
         /// <returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
         public static V GetOrAdd<K, V>(this ConcurrentDictionary<K, AtomicFactory<K, V>> dictionary, K key, Func<K, V> valueFactory)
+             where K : notnull
         {
             var atomicFactory = dictionary.GetOrAdd(key, _ => new AtomicFactory<K, V>());
             return atomicFactory.GetValue(key, valueFactory);
@@ -32,6 +33,7 @@ public static V GetOrAdd<K, V>(this ConcurrentDictionary<K, AtomicFactory<K, V>>
         /// <param name="factoryArgument">An argument value to pass into valueFactory.</param>
         /// <returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
         public static V GetOrAdd<K, V, TArg>(this ConcurrentDictionary<K, AtomicFactory<K, V>> dictionary, K key, Func<K, TArg, V> valueFactory, TArg factoryArgument)
+             where K : notnull
         {
             var atomicFactory = dictionary.GetOrAdd(key, _ => new AtomicFactory<K, V>());
             return atomicFactory.GetValue(key, valueFactory, factoryArgument);
@@ -45,6 +47,7 @@ public static V GetOrAdd<K, V, TArg>(this ConcurrentDictionary<K, AtomicFactory<
         /// <param name="valueFactory">The function used to generate a value for the key.</param>
         /// <returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
         public static ValueTask<V> GetOrAddAsync<K, V>(this ConcurrentDictionary<K, AsyncAtomicFactory<K, V>> dictionary, K key, Func<K, Task<V>> valueFactory)
+             where K : notnull
         {
             var asyncAtomicFactory = dictionary.GetOrAdd(key, _ => new AsyncAtomicFactory<K, V>());
             return asyncAtomicFactory.GetValueAsync(key, valueFactory);
@@ -59,6 +62,7 @@ public static ValueTask<V> GetOrAddAsync<K, V>(this ConcurrentDictionary<K, Asyn
         /// <param name="factoryArgument">An argument value to pass into valueFactory.</param>
         /// <returns>The value for the key. This will be either the existing value for the key if the key is already in the dictionary, or the new value if the key was not in the dictionary.</returns>
         public static ValueTask<V> GetOrAddAsync<K, V, TArg>(this ConcurrentDictionary<K, AsyncAtomicFactory<K, V>> dictionary, K key, Func<K, TArg, Task<V>> valueFactory, TArg factoryArgument)
+             where K : notnull
         {
             var asyncAtomicFactory = dictionary.GetOrAdd(key, _ => new AsyncAtomicFactory<K, V>());
             return asyncAtomicFactory.GetValueAsync(key, valueFactory, factoryArgument);
@@ -72,6 +76,7 @@ public static ValueTask<V> GetOrAddAsync<K, V, TArg>(this ConcurrentDictionary<K
         /// <param name="value">When this method returns, contains the object from the ConcurrentDictionary that has the specified key, or the default value of the type if the operation failed.</param>
         /// <returns>true if the key was found in the ConcurrentDictionary; otherwise, false.</returns>
         public static bool TryGetValue<K, V>(this ConcurrentDictionary<K, AtomicFactory<K, V>> dictionary, K key, out V value)
+             where K : notnull
         {
             AtomicFactory<K, V> output;
             var ret = dictionary.TryGetValue(key, out output);
@@ -93,6 +98,7 @@ public static bool TryGetValue<K, V>(this ConcurrentDictionary<K, AtomicFactory<
         /// <param name="key">The key of the value to get.</param>
         /// <param name="value">When this method returns, contains the object from the ConcurrentDictionary that has the specified key, or the default value of the type if the operation failed.</param>
         public static bool TryGetValue<K, V>(this ConcurrentDictionary<K, AsyncAtomicFactory<K, V>> dictionary, K key, out V value)
+             where K : notnull
         {
             AsyncAtomicFactory<K, V> output;
             var ret = dictionary.TryGetValue(key, out output);
@@ -114,6 +120,7 @@ public static bool TryGetValue<K, V>(this ConcurrentDictionary<K, AsyncAtomicFac
         /// <param name="item">The KeyValuePair representing the key and value to remove.</param>
         /// <returns>true if the object was removed successfully; otherwise, false.</returns>
         public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AtomicFactory<K, V>> dictionary, KeyValuePair<K, V> item)
+             where K : notnull
         {
             var kvp = new KeyValuePair<K, AtomicFactory<K, V>>(item.Key, new AtomicFactory<K, V>(item.Value));
 #if NET6_0_OR_GREATER
@@ -131,6 +138,7 @@ public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AtomicFactory<K,
         /// <param name="item">The KeyValuePair representing the key and value to remove.</param>
         /// <returns>true if the object was removed successfully; otherwise, false.</returns>
         public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AsyncAtomicFactory<K, V>> dictionary, KeyValuePair<K, V> item)
+             where K : notnull
         {
             var kvp = new KeyValuePair<K, AsyncAtomicFactory<K, V>>(item.Key, new AsyncAtomicFactory<K, V>(item.Value));
 #if NET6_0_OR_GREATER
@@ -149,6 +157,7 @@ public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AsyncAtomicFacto
         /// <param name="value">When this method returns, contains the object removed from the ConcurrentDictionary, or the default value of the TValue type if key does not exist.</param>
         /// <returns>true if the object was removed successfully; otherwise, false.</returns>
         public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AtomicFactory<K, V>> dictionary, K key, out V value)
+             where K : notnull
         {
             if (dictionary.TryRemove(key, out var atomic))
             {
@@ -168,6 +177,7 @@ public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AtomicFactory<K,
         /// <param name="value">When this method returns, contains the object removed from the ConcurrentDictionary, or the default value of the TValue type if key does not exist.</param>
         /// <returns>true if the object was removed successfully; otherwise, false.</returns>
         public static bool TryRemove<K, V>(this ConcurrentDictionary<K, AsyncAtomicFactory<K, V>> dictionary, K key, out V value)
+             where K : notnull
         {
             if (dictionary.TryRemove(key, out var atomic))
             {

BitFaster.Caching/Atomic/ScopedAsyncAtomicFactory.cs

@@ -12,7 +12,9 @@ namespace BitFaster.Caching.Atomic
     /// <typeparam name="K">The type of the key.</typeparam>
     /// <typeparam name="V">The type of the value.</typeparam>
     [DebuggerDisplay("IsScopeCreated={initializer == null}, Value={ScopeIfCreated}")]
-    public sealed class ScopedAsyncAtomicFactory<K, V> : IScoped<V>, IDisposable where V : IDisposable
+    public sealed class ScopedAsyncAtomicFactory<K, V> : IScoped<V>, IDisposable
+        where K : notnull
+        where V : IDisposable
     {
         private Scoped<V> scope;
         private Initializer initializer;

BitFaster.Caching/Atomic/ScopedAtomicFactory.cs

@@ -27,7 +27,9 @@ namespace BitFaster.Caching.Atomic
     ///</list>
     /// </remarks>
     [DebuggerDisplay("IsScopeCreated={initializer == null}, Value={ScopeIfCreated}")]
-    public sealed class ScopedAtomicFactory<K, V> : IScoped<V>, IDisposable where V : IDisposable
+    public sealed class ScopedAtomicFactory<K, V> : IScoped<V>, IDisposable
+        where K : notnull
+        where V : IDisposable
     {
         private Scoped<V> scope;
         private Initializer initializer;

BitFaster.Caching/BitFaster.Caching.csproj

@@ -27,6 +27,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <AllowUnsafeBlocks>True</AllowUnsafeBlocks>
     <IsTrimmable>true</IsTrimmable>
+    <Nullable>disable</Nullable>
     <!--Package Validation-->
     <EnablePackageValidation>true</EnablePackageValidation>
     <PackageValidationBaselineVersion>2.4.0</PackageValidationBaselineVersion>