-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathIImmutableQueue`1.xml
More file actions
246 lines (244 loc) · 14.5 KB
/
IImmutableQueue`1.xml
File metadata and controls
246 lines (244 loc) · 14.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<Type Name="IImmutableQueue<T>" FullName="System.Collections.Immutable.IImmutableQueue<T>">
<TypeSignature Language="C#" Value="public interface IImmutableQueue<T> : System.Collections.Generic.IEnumerable<T>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IImmutableQueue`1<T> implements class System.Collections.Generic.IEnumerable`1<!T>, class System.Collections.IEnumerable" FrameworkAlternate="dotnet-uwp-10.0;net-5.0;net-6.0;net-7.0;netcore-1.0;netcore-1.1;netcore-2.0;netcore-2.1;netcore-2.2;netcore-3.0;netcore-3.1" />
<TypeSignature Language="DocId" Value="T:System.Collections.Immutable.IImmutableQueue`1" />
<TypeSignature Language="VB.NET" Value="Public Interface IImmutableQueue(Of T)
Implements IEnumerable(Of T)" />
<TypeSignature Language="F#" Value="type IImmutableQueue<'T> = interface
 interface seq<'T>
 interface IEnumerable" />
<TypeSignature Language="C++ CLI" Value="generic <typename T>
public interface class IImmutableQueue : System::Collections::Generic::IEnumerable<T>" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IImmutableQueue`1<T> implements class System.Collections.Generic.IEnumerable`1<!T>, class System.Collections.IEnumerable" FrameworkAlternate="net-10.0;net-10.0-pp;net-11.0;net-11.0-pp;net-8.0;net-9.0;netframework-4.6.2-pp;netframework-4.7.1-pp;netframework-4.7.2-pp;netframework-4.7-pp;netframework-4.8.1-pp;netframework-4.8-pp;netstandard-2.0-pp" />
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.1</AssemblyVersion>
<AssemblyVersion>10.0.0.2</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-11.0;net-11.0-pp;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
</Attributes>
</TypeParameter>
</TypeParameters>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.Generic.IEnumerable<T></InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute FrameworkAlternate="net-10.0;net-10.0-pp;net-11.0;net-11.0-pp;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableQueue), "Create")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.CollectionBuilder(typeof(System.Collections.Immutable.ImmutableQueue), "Create")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<typeparam name="T">The type of elements in the queue.</typeparam>
<summary>Represents an immutable first-in, first-out collection of objects.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Because <xref:System.Collections.Immutable.IImmutableQueue%601> is immutable, when you change <xref:System.Collections.Immutable.IImmutableQueue%601> using methods such as <xref:System.Collections.Immutable.IImmutableQueue%601.Dequeue%2A> or <xref:System.Collections.Immutable.IImmutableQueue%601.Enqueue%2A>, a new queue will be returned with the changes applied and the original queue remains unchanged.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public System.Collections.Immutable.IImmutableQueue<T> Clear ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Immutable.IImmutableQueue`1<!T> Clear() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.IImmutableQueue`1.Clear" />
<MemberSignature Language="VB.NET" Value="Public Function Clear () As IImmutableQueue(Of T)" />
<MemberSignature Language="F#" Value="abstract member Clear : unit -> System.Collections.Immutable.IImmutableQueue<'T>" Usage="iImmutableQueue.Clear " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Immutable::IImmutableQueue<T> ^ Clear();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.IImmutableQueue<T></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a new queue with all the elements removed.</summary>
<returns>An empty immutable queue.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dequeue">
<MemberSignature Language="C#" Value="public System.Collections.Immutable.IImmutableQueue<T> Dequeue ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Immutable.IImmutableQueue`1<!T> Dequeue() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.IImmutableQueue`1.Dequeue" />
<MemberSignature Language="VB.NET" Value="Public Function Dequeue () As IImmutableQueue(Of T)" />
<MemberSignature Language="F#" Value="abstract member Dequeue : unit -> System.Collections.Immutable.IImmutableQueue<'T>" Usage="iImmutableQueue.Dequeue " />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Immutable::IImmutableQueue<T> ^ Dequeue();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.IImmutableQueue<T></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes the first element in the immutable queue, and returns the new queue.</summary>
<returns>The new immutable queue with the first element removed. This value is never <see langword="null" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The queue is empty.</exception>
</Docs>
</Member>
<Member MemberName="Enqueue">
<MemberSignature Language="C#" Value="public System.Collections.Immutable.IImmutableQueue<T> Enqueue (T value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.Immutable.IImmutableQueue`1<!T> Enqueue(!T value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.IImmutableQueue`1.Enqueue(`0)" />
<MemberSignature Language="VB.NET" Value="Public Function Enqueue (value As T) As IImmutableQueue(Of T)" />
<MemberSignature Language="F#" Value="abstract member Enqueue : 'T -> System.Collections.Immutable.IImmutableQueue<'T>" Usage="iImmutableQueue.Enqueue value" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::Immutable::IImmutableQueue<T> ^ Enqueue(T value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.IImmutableQueue<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="T" />
</Parameters>
<Docs>
<param name="value">The element to add.</param>
<summary>Adds an element to the end of the immutable queue, and returns the new queue.</summary>
<returns>The new immutable queue with the specified element added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsEmpty">
<MemberSignature Language="C#" Value="public bool IsEmpty { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsEmpty" />
<MemberSignature Language="DocId" Value="P:System.Collections.Immutable.IImmutableQueue`1.IsEmpty" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsEmpty As Boolean" />
<MemberSignature Language="F#" Value="member this.IsEmpty : bool" Usage="System.Collections.Immutable.IImmutableQueue<'T>.IsEmpty" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsEmpty { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this immutable queue is empty.</summary>
<value>
<see langword="true" /> if this queue is empty; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public T Peek ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !T Peek() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.IImmutableQueue`1.Peek" />
<MemberSignature Language="VB.NET" Value="Public Function Peek () As T" />
<MemberSignature Language="F#" Value="abstract member Peek : unit -> 'T" Usage="iImmutableQueue.Peek " />
<MemberSignature Language="C++ CLI" Value="public:
 T Peek();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>1.1.37.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.2.1.0</AssemblyVersion>
<AssemblyVersion>1.2.2.0</AssemblyVersion>
<AssemblyVersion>1.2.3.0</AssemblyVersion>
<AssemblyVersion>1.2.4.0</AssemblyVersion>
<AssemblyVersion>1.2.5.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
<AssemblyVersion>10.0.0.0</AssemblyVersion>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the element at the beginning of the immutable queue without removing it.</summary>
<returns>The element at the beginning of the queue.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The queue is empty.</exception>
</Docs>
</Member>
</Members>
</Type>