Consistent debug view (#307)

* debug view

* rem ns

* excl

Author: bitfaster

BitFaster.Caching/Atomic/AtomicFactoryAsyncCache.cs

@@ -2,6 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.Threading.Tasks;
 
 namespace BitFaster.Caching.Atomic
@@ -11,6 +12,7 @@ namespace BitFaster.Caching.Atomic
     /// </summary>
     /// <typeparam name="K">The type of keys in the cache.</typeparam>
     /// <typeparam name="V">The type of values in the cache.</typeparam>
+    [DebuggerTypeProxy(typeof(AtomicFactoryAsyncCache<,>.AsyncCacheDebugView))]
     [DebuggerDisplay("Count = {Count}")]
     public sealed class AtomicFactoryAsyncCache<K, V> : IAsyncCache<K, V>
     {
@@ -133,5 +135,33 @@ protected override ItemUpdatedEventArgs<K, V> TranslateOnUpdated(ItemUpdatedEven
                 return new ItemUpdatedEventArgs<K, V>(inner.Key, inner.OldValue.ValueIfCreated, inner.NewValue.ValueIfCreated);
             }
         }
+
+        [ExcludeFromCodeCoverage]
+        internal class AsyncCacheDebugView
+        {
+            private readonly IAsyncCache<K, V> cache;
+
+            public AsyncCacheDebugView(IAsyncCache<K, V> cache)
+            {
+                this.cache = cache;
+            }
+
+            public KeyValuePair<K, V>[] Items
+            {
+                get
+                {
+                    var items = new KeyValuePair<K, V>[cache.Count];
+
+                    int index = 0;
+                    foreach (var kvp in cache)
+                    {
+                        items[index++] = kvp;
+                    }
+                    return items;
+                }
+            }
+
+            public ICacheMetrics Metrics => cache.Metrics.Value;
+        }
     }
 }

BitFaster.Caching/Atomic/AtomicFactoryCache.cs

@@ -10,6 +10,7 @@ namespace BitFaster.Caching.Atomic
     /// </summary>
     /// <typeparam name="K">The type of keys in the cache.</typeparam>
     /// <typeparam name="V">The type of values in the cache.</typeparam>
+    [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}")]
     public sealed class AtomicFactoryCache<K, V> : ICache<K, V>
     {

BitFaster.Caching/Atomic/AtomicFactoryScopedAsyncCache.cs

@@ -12,6 +12,7 @@ namespace BitFaster.Caching.Atomic
     /// </summary>
     /// <typeparam name="K">The type of keys in the cache.</typeparam>
     /// <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
     {

BitFaster.Caching/Atomic/AtomicFactoryScopedCache.cs

@@ -11,6 +11,7 @@ namespace BitFaster.Caching.Atomic
     /// </summary>
     /// <typeparam name="K">The type of keys in the cache.</typeparam>
     /// <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
     {

BitFaster.Caching/Lru/LruDebugView.cs renamed to BitFaster.Caching/CacheDebugView.cs

@@ -1,16 +1,15 @@
-using System;
-using System.Collections;
+
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 
-namespace BitFaster.Caching.Lru
+namespace BitFaster.Caching
 {
     [ExcludeFromCodeCoverage]
-    internal class LruDebugView<K, V>
+    internal class CacheDebugView<K, V>
     {
         private readonly ICache<K, V> cache;
 
-        public LruDebugView(ICache<K, V> cache)
+        public CacheDebugView(ICache<K, V> cache)
         {
             if (cache is null)
             {

BitFaster.Caching/Lru/ConcurrentLru.cs

@@ -4,7 +4,7 @@
 namespace BitFaster.Caching.Lru
 {
     ///<inheritdoc/>
-    [DebuggerTypeProxy(typeof(LruDebugView<,>))]
+    [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class ConcurrentLru<K, V> : ConcurrentLruCore<K, V, LruItem<K, V>, LruPolicy<K, V>, TelemetryPolicy<K, V>>
     {

BitFaster.Caching/Lru/ConcurrentTLru.cs

@@ -5,7 +5,7 @@
 namespace BitFaster.Caching.Lru
 {
     ///<inheritdoc/>
-    [DebuggerTypeProxy(typeof(LruDebugView<,>))]
+    [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class ConcurrentTLru<K, V> : ConcurrentLruCore<K, V, LongTickCountLruItem<K, V>, TLruLongTicksPolicy<K, V>, TelemetryPolicy<K, V>>
     {

BitFaster.Caching/Lru/FastConcurrentLru.cs

@@ -4,7 +4,7 @@
 namespace BitFaster.Caching.Lru
 {
     ///<inheritdoc/>
-    [DebuggerTypeProxy(typeof(LruDebugView<,>))]
+    [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class FastConcurrentLru<K, V> : ConcurrentLruCore<K, V, LruItem<K, V>, LruPolicy<K, V>, NoTelemetryPolicy<K, V>>
     {

BitFaster.Caching/Lru/FastConcurrentTLru.cs

@@ -5,7 +5,7 @@
 namespace BitFaster.Caching.Lru
 {
     ///<inheritdoc/>
-    [DebuggerTypeProxy(typeof(LruDebugView<,>))]
+    [DebuggerTypeProxy(typeof(CacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}/{Capacity}")]
     public sealed class FastConcurrentTLru<K, V> : ConcurrentLruCore<K, V, LongTickCountLruItem<K, V>, TLruLongTicksPolicy<K, V>, NoTelemetryPolicy<K, V>>
     {

BitFaster.Caching/ScopedAsyncCache.cs

@@ -14,6 +14,7 @@ namespace BitFaster.Caching
     /// </summary>
     /// <typeparam name="K">The type of keys in the cache.</typeparam>
     /// <typeparam name="V">The type of values in the cache.</typeparam>
+    [DebuggerTypeProxy(typeof(ScopedAsyncCacheDebugView<,>))]
     [DebuggerDisplay("Count = {Count}")]
     public sealed class ScopedAsyncCache<K, V> : IScopedAsyncCache<K, V> where V : IDisposable
     {