-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ImmutableStack.xml
331 lines (330 loc) · 20.8 KB
/
ImmutableStack.xml
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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<Type Name="ImmutableStack" FullName="System.Collections.Immutable.ImmutableStack">
<TypeSignature Language="C#" Value="public static class ImmutableStack" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ImmutableStack extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Collections.Immutable.ImmutableStack" />
<TypeSignature Language="VB.NET" Value="Public Module ImmutableStack" />
<TypeSignature Language="F#" Value="type ImmutableStack = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ImmutableStack abstract sealed" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides a set of initialization methods for instances of the <see cref="T:System.Collections.Immutable.ImmutableStack`1" /> class.
**NuGet package**: <see href="https://www.nuget.org/packages/System.Collections.Immutable/">System.Collections.Immutable</see> (<see href="https://learn.microsoft.com/dotnet/api/system.collections.immutable?#remarks">about immutable collections and how to install</see>)</summary>
<remarks>To be added.</remarks>
<threadsafe>This type is thread safe.</threadsafe>
</Docs>
<Members>
<Member MemberName="Create<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> Create<T> ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.ImmutableStack`1<!!T> Create<T>() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.Create``1" />
<MemberSignature Language="VB.NET" Value="Public Function Create(Of T) () As ImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member Create : unit -> System.Collections.Immutable.ImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.Create " />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static System::Collections::Immutable::ImmutableStack<T> ^ Create();" />
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.ImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters />
<Docs>
<typeparam name="T">The type of items to be stored in the immutable stack.</typeparam>
<summary>Creates an empty immutable stack.</summary>
<returns>An empty immutable stack.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> Create<T> (ReadOnlySpan<T> items);" FrameworkAlternate="net-6.0;net-7.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.ImmutableStack`1<!!T> Create<T>(valuetype System.ReadOnlySpan`1<!!T> items) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.Create``1(System.ReadOnlySpan{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function Create(Of T) (items As ReadOnlySpan(Of T)) As ImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member Create : ReadOnlySpan<'T> -> System.Collections.Immutable.ImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.Create items" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static System::Collections::Immutable::ImmutableStack<T> ^ Create(ReadOnlySpan<T> items);" />
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> Create<T> (scoped ReadOnlySpan<T> items);" FrameworkAlternate="net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Collections.Immutable</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.ImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters>
<Parameter Name="items" Type="System.ReadOnlySpan<T>" Index="0" FrameworkAlternate="net-8.0;net-9.0;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;netstandard-2.0;net-6.0;net-7.0">
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(new System.Byte[] { 0, 1 })>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.ScopedRef]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.ScopedRef>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.ParamCollection]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.ParamCollection>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">The type of items in the immutable stack.</typeparam>
<param name="items">A span that contains the items to prepopulate the stack with.</param>
<summary>Creates a new immutable stack that contains the specified array of items.</summary>
<returns>A new immutable stack that contains the specified items.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> Create<T> (T item);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.ImmutableStack`1<!!T> Create<T>(!!T item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.Create``1(``0)" />
<MemberSignature Language="VB.NET" Value="Public Function Create(Of T) (item As T) As ImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member Create : 'T -> System.Collections.Immutable.ImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.Create item" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static System::Collections::Immutable::ImmutableStack<T> ^ Create(T item);" />
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.ImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters>
<Parameter Name="item" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">The type of items in the immutable stack.</typeparam>
<param name="item">The item to prepopulate the stack with.</param>
<summary>Creates a new immutable stack that contains the specified item.</summary>
<returns>A new immutable collection that contains the specified item.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> Create<T> (params T[] items);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.ImmutableStack`1<!!T> Create<T>(!!T[] items) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.Create``1(``0[])" />
<MemberSignature Language="VB.NET" Value="Public Function Create(Of T) (ParamArray items As T()) As ImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member Create : 'T[] -> System.Collections.Immutable.ImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.Create items" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static System::Collections::Immutable::ImmutableStack<T> ^ Create(... cli::array <T> ^ items);" />
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.ImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters>
<Parameter Name="items" Type="T[]">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<typeparam name="T">The type of items in the immutable stack.</typeparam>
<param name="items">An array that contains the items to prepopulate the stack with.</param>
<summary>Creates a new immutable stack that contains the specified array of items.</summary>
<returns>A new immutable stack that contains the specified items.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateRange<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.ImmutableStack<T> CreateRange<T> (System.Collections.Generic.IEnumerable<T> items);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.ImmutableStack`1<!!T> CreateRange<T>(class System.Collections.Generic.IEnumerable`1<!!T> items) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.CreateRange``1(System.Collections.Generic.IEnumerable{``0})" />
<MemberSignature Language="VB.NET" Value="Public Function CreateRange(Of T) (items As IEnumerable(Of T)) As ImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member CreateRange : seq<'T> -> System.Collections.Immutable.ImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.CreateRange items" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 static System::Collections::Immutable::ImmutableStack<T> ^ CreateRange(System::Collections::Generic::IEnumerable<T> ^ items);" />
<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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.ImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters>
<Parameter Name="items" Type="System.Collections.Generic.IEnumerable<T>" />
</Parameters>
<Docs>
<typeparam name="T">The type of items in the stack.</typeparam>
<param name="items">The items to add to the stack before it's immutable.</param>
<summary>Creates a new immutable stack that contains the specified items.</summary>
<returns>An immutable stack that contains the specified items.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pop<T>">
<MemberSignature Language="C#" Value="public static System.Collections.Immutable.IImmutableStack<T> Pop<T> (this System.Collections.Immutable.IImmutableStack<T> stack, out T value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Collections.Immutable.IImmutableStack`1<!!T> Pop<T>(class System.Collections.Immutable.IImmutableStack`1<!!T> stack, [out] !!T& value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Collections.Immutable.ImmutableStack.Pop``1(System.Collections.Immutable.IImmutableStack{``0},``0@)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function Pop(Of T) (stack As IImmutableStack(Of T), ByRef value As T) As IImmutableStack(Of T)" />
<MemberSignature Language="F#" Value="static member Pop : System.Collections.Immutable.IImmutableStack<'T> * 'T -> System.Collections.Immutable.IImmutableStack<'T>" Usage="System.Collections.Immutable.ImmutableStack.Pop (stack, value)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
[System::Runtime::CompilerServices::Extension]
 static System::Collections::Immutable::IImmutableStack<T> ^ Pop(System::Collections::Immutable::IImmutableStack<T> ^ stack, [Runtime::InteropServices::Out] 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>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Immutable.IImmutableStack<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Attributes>
<Attribute FrameworkAlternate="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>
<Parameters>
<Parameter Name="stack" Type="System.Collections.Immutable.IImmutableStack<T>" RefType="this" />
<Parameter Name="value" Type="T" RefType="out" />
</Parameters>
<Docs>
<typeparam name="T">The type of items contained in the stack.</typeparam>
<param name="stack">The stack to modify.</param>
<param name="value">The item to remove from the stack.</param>
<summary>Removes the specified item from an immutable stack.</summary>
<returns>A stack; never <see langword="null" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The stack is empty.</exception>
</Docs>
</Member>
</Members>
</Type>