Add GetQueueElements to AsyncQueue<T> (#986)

microsoft · Feb 8, 2022 · 0110874 · 0110874
1 parent 26b09cb
commit 0110874
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs b/src/Microsoft.VisualStudio.Threading/AsyncQueue`1.cs
@@ -81,6 +81,17 @@ public int Count
             }
         }
 
+        /// <summary>
+        /// Returns the list of elements currently in the queue.
+        /// </summary>
+        public IReadOnlyList<T> GetQueueElements()
+        {
+            lock (this.SyncRoot)
+            {
+                return (IReadOnlyList<T>?)this.queueElements?.ToList() ?? Array.Empty<T>();
+            }
+        }
+
         /// <summary>
         /// Gets a value indicating whether the queue has completed.
         /// </summary>

diff --git a/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt b/src/Microsoft.VisualStudio.Threading/netstandard2.0/PublicAPI.Unshipped.txt
@@ -1,3 +1,4 @@
+Microsoft.VisualStudio.Threading.AsyncQueue<T>.GetQueueElements() -> System.Collections.Generic.IReadOnlyList<T>!
 Microsoft.VisualStudio.Threading.AsyncReaderWriterLock.AsyncReaderWriterLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics = false) -> void
 Microsoft.VisualStudio.Threading.AsyncReaderWriterResourceLock<TMoniker, TResource>.AsyncReaderWriterResourceLock(Microsoft.VisualStudio.Threading.JoinableTaskContext? joinableTaskContext, bool captureDiagnostics) -> void
 Microsoft.VisualStudio.Threading.JoinableTaskContext.IsMainThreadMaybeBlocked() -> bool

diff --git a/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs b/test/Microsoft.VisualStudio.Threading.Tests/AsyncQueueTests.cs
@@ -25,6 +25,7 @@ public void JustInitialized()
         Assert.Equal(0, this.queue.Count);
         Assert.True(this.queue.IsEmpty);
         Assert.False(this.queue.Completion.IsCompleted);
+        Assert.Equal(0, this.queue.GetQueueElements().Count);
     }
 
     [Fact]
@@ -34,6 +35,7 @@ public void Enqueue()
         this.queue.Enqueue(value);
         Assert.Equal(1, this.queue.Count);
         Assert.False(this.queue.IsEmpty);
+        Assert.Equal(1, this.queue.GetQueueElements().Count);
     }
 
     [Fact]
@@ -43,6 +45,7 @@ public void TryEnqueue()
         Assert.True(this.queue.TryEnqueue(value));
         Assert.Equal(1, this.queue.Count);
         Assert.False(this.queue.IsEmpty);
+        Assert.Equal(1, this.queue.GetQueueElements().Count);
     }
 
     [Fact]