Queue<T> F# snippet (#8871)

Author: albert-du

snippets/fsharp/System.Collections.Generic/QueueT/Overview/fs.fsproj

@@ -0,0 +1,10 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="source.fs" />
+  </ItemGroup>
+</Project>

snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs

@@ -0,0 +1,77 @@
+module source
+//<Snippet1>
+open System
+open System.Collections.Generic
+
+let numbers = Queue()
+numbers.Enqueue "one"
+numbers.Enqueue "two"
+numbers.Enqueue "three"
+numbers.Enqueue "four"
+numbers.Enqueue "five"
+
+// A queue can be enumerated without disturbing its contents.
+for number in numbers do
+    printfn $"{number}"
+
+printfn $"\nDequeuing '{numbers.Dequeue()}'"
+printfn $"Peek at next item to dequeue: {numbers.Peek()}"
+printfn $"Dequeuing '{numbers.Dequeue()}'"
+
+// Create a copy of the queue, using the ToArray method and the
+// constructor that accepts an IEnumerable<T>.
+let queueCopy = numbers.ToArray() |> Queue
+
+printfn $"\nContents of the first copy:"
+for number in queueCopy do
+    printfn $"{number}"
+
+// Create an array twice the size of the queue and copy the
+// elements of the queue, starting at the middle of the
+// array.
+let array2 = numbers.Count * 2 |> Array.zeroCreate
+numbers.CopyTo(array2, numbers.Count)
+
+// Create a second queue, using the constructor that accepts an
+// IEnumerable(Of T).
+let queueCopy2 = Queue array2
+
+printfn $"\nContents of the second copy, with duplicates and nulls:"
+for number in queueCopy2 do
+    printfn $"{number}"
+printfn $"""\nqueueCopy.Contains "four" = {queueCopy.Contains "four"}"""
+
+printfn $"\nqueueCopy.Clear()"
+queueCopy.Clear()
+printfn $"queueCopy.Count = {queueCopy.Count}"
+
+// This code example produces the following output:
+//       one
+//       two
+//       three
+//       four
+//       five
+//       
+//       Dequeuing 'one'
+//       Peek at next item to dequeue: two
+//       Dequeuing 'two'
+//       
+//       Contents of the first copy:
+//       three
+//       four
+//       five
+//       
+//       Contents of the second copy, with duplicates and nulls:
+//       
+//       
+//       
+//       three
+//       four
+//       five
+//       
+//       queueCopy.Contains "four" = True
+//       
+//       queueCopy.Clear()
+//       
+//       queueCopy.Count = 0
+//</Snippet1>

xml/System.Collections.Generic/Queue`1.xml

@@ -113,6 +113,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>
@@ -145,6 +146,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1"::: 
   
  ]]></format>
@@ -369,6 +371,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::
   
  ]]></format>
@@ -439,6 +442,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>
@@ -574,6 +578,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1"::: 
   
  ]]></format>
@@ -641,6 +646,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>
@@ -711,6 +717,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>
@@ -824,6 +831,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>
@@ -893,6 +901,7 @@
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::
   
  ]]></format>
@@ -1313,6 +1322,7 @@ finally {
  The <xref:System.Collections.Generic.Queue%601.Contains%2A> method is used to show that the string "four" is in the first copy of the queue, after which the <xref:System.Collections.Generic.Queue%601.Clear%2A> method clears the copy and the <xref:System.Collections.Generic.Queue%601.Count%2A> property shows that the queue is empty.  
   
  :::code language="csharp" source="~/snippets/csharp/System.Collections.Generic/QueueT/Overview/source.cs" interactive="try-dotnet" id="Snippet1":::
+ :::code language="fsharp" source="~/snippets/fsharp/System.Collections.Generic/QueueT/Overview/source.fs" id="Snippet1":::
  :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Generic.Queue/vb/source.vb" id="Snippet1":::  
   
  ]]></format>