-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
XxHash32.xml
366 lines (363 loc) · 21.6 KB
/
XxHash32.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
<Type Name="XxHash32" FullName="System.IO.Hashing.XxHash32">
<TypeSignature Language="C#" Value="public sealed class XxHash32 : System.IO.Hashing.NonCryptographicHashAlgorithm" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit XxHash32 extends System.IO.Hashing.NonCryptographicHashAlgorithm" />
<TypeSignature Language="DocId" Value="T:System.IO.Hashing.XxHash32" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class XxHash32
Inherits NonCryptographicHashAlgorithm" />
<TypeSignature Language="F#" Value="type XxHash32 = class
 inherit NonCryptographicHashAlgorithm" />
<TypeSignature Language="C++ CLI" Value="public ref class XxHash32 sealed : System::IO::Hashing::NonCryptographicHashAlgorithm" />
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<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.IO.Hashing.NonCryptographicHashAlgorithm</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides an implementation of the XxHash32 algorithm.</summary>
<remarks>For methods that persist the computed numerical hash value as bytes, the value is written in the Big Endian byte order.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XxHash32 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 XxHash32();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The XxHash32 algorithm supports an optional seed value.
Instances created with this constructor use the default seed, zero.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public XxHash32 (int seed);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.#ctor(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (seed As Integer)" />
<MemberSignature Language="F#" Value="new System.IO.Hashing.XxHash32 : int -> System.IO.Hashing.XxHash32" Usage="new System.IO.Hashing.XxHash32 seed" />
<MemberSignature Language="C++ CLI" Value="public:
 XxHash32(int seed);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="seed">The hash seed value for computations from this instance.</param>
<summary>Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32" /> class with a specified seed.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Append">
<MemberSignature Language="C#" Value="public override void Append (ReadOnlySpan<byte> source);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Append(valuetype System.ReadOnlySpan`1<unsigned int8> source) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Append(System.ReadOnlySpan{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Append (source As ReadOnlySpan(Of Byte))" />
<MemberSignature Language="F#" Value="override this.Append : ReadOnlySpan<byte> -> unit" Usage="xxHash32.Append source" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Append(ReadOnlySpan<System::Byte> source);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
</Parameters>
<Docs>
<param name="source">The data to process.</param>
<summary>Appends the contents of <paramref name="source" /> to the data already processed for the current hash computation.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentHashAsUInt32">
<MemberSignature Language="C#" Value="public uint GetCurrentHashAsUInt32 ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int32 GetCurrentHashAsUInt32() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.GetCurrentHashAsUInt32" />
<MemberSignature Language="VB.NET" Value="Public Function GetCurrentHashAsUInt32 () As UInteger" />
<MemberSignature Language="F#" Value="member this.GetCurrentHashAsUInt32 : unit -> uint32" Usage="xxHash32.GetCurrentHashAsUInt32 " />
<MemberSignature Language="C++ CLI" Value="public:
 System::UInt32 GetCurrentHashAsUInt32();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>
<AttributeName Language="F#">[<System.CLSCompliant(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the current computed hash value without modifying accumulated state.</summary>
<returns>The hash value for the data already provided.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetCurrentHashCore">
<MemberSignature Language="C#" Value="protected override void GetCurrentHashCore (Span<byte> destination);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void GetCurrentHashCore(valuetype System.Span`1<unsigned int8> destination) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.GetCurrentHashCore(System.Span{System.Byte})" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub GetCurrentHashCore (destination As Span(Of Byte))" />
<MemberSignature Language="F#" Value="override this.GetCurrentHashCore : Span<byte> -> unit" Usage="xxHash32.GetCurrentHashCore destination" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void GetCurrentHashCore(Span<System::Byte> destination);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="destination" Type="System.Span<System.Byte>" />
</Parameters>
<Docs>
<param name="destination">To be added.</param>
<summary>Writes the computed hash value to <paramref name="destination" /> without modifying accumulated state.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public static byte[] Hash (byte[] source);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] Hash(unsigned int8[] source) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Hash(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Hash (source As Byte()) As Byte()" />
<MemberSignature Language="F#" Value="static member Hash : byte[] -> byte[]" Usage="System.IO.Hashing.XxHash32.Hash source" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::Byte> ^ Hash(cli::array <System::Byte> ^ source);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<summary>Computes the XxHash32 hash of the provided data.</summary>
<returns>The XxHash32 hash of the provided data.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public static byte[] Hash (byte[] source, int seed);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] Hash(unsigned int8[] source, int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Hash(System.Byte[],System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Hash (source As Byte(), seed As Integer) As Byte()" />
<MemberSignature Language="F#" Value="static member Hash : byte[] * int -> byte[]" Usage="System.IO.Hashing.XxHash32.Hash (source, seed)" />
<MemberSignature Language="C++ CLI" Value="public:
 static cli::array <System::Byte> ^ Hash(cli::array <System::Byte> ^ source, int seed);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<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>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.Byte[]" />
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<param name="seed">The seed value for this hash computation.</param>
<summary>Computes the XxHash32 hash of the provided data using the provided seed.</summary>
<returns>The XxHash32 hash of the provided data.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="source" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public static byte[] Hash (ReadOnlySpan<byte> source, int seed = 0);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int8[] Hash(valuetype System.ReadOnlySpan`1<unsigned int8> source, int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Hash (source As ReadOnlySpan(Of Byte), Optional seed As Integer = 0) As Byte()" />
<MemberSignature Language="F#" Value="static member Hash : ReadOnlySpan<byte> * int -> byte[]" Usage="System.IO.Hashing.XxHash32.Hash (source, seed)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<param name="seed">The seed value for this hash computation. The default is zero.</param>
<summary>Computes the XxHash32 hash of the provided data.</summary>
<returns>The XxHash32 hash of the provided data.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Hash">
<MemberSignature Language="C#" Value="public static int Hash (ReadOnlySpan<byte> source, Span<byte> destination, int seed = 0);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig int32 Hash(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Hash (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), Optional seed As Integer = 0) As Integer" />
<MemberSignature Language="F#" Value="static member Hash : ReadOnlySpan<byte> * Span<byte> * int -> int" Usage="System.IO.Hashing.XxHash32.Hash (source, destination, seed)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<param name="destination">The buffer that receives the computed hash value.</param>
<param name="seed">The seed value for this hash computation. The default is zero.</param>
<summary>Computes the XxHash32 hash of the provided data into the provided destination.</summary>
<returns>The number of bytes written to <paramref name="destination" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HashToUInt32">
<MemberSignature Language="C#" Value="public static uint HashToUInt32 (ReadOnlySpan<byte> source, int seed = 0);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int32 HashToUInt32(valuetype System.ReadOnlySpan`1<unsigned int8> source, int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.HashToUInt32(System.ReadOnlySpan{System.Byte},System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function HashToUInt32 (source As ReadOnlySpan(Of Byte), Optional seed As Integer = 0) As UInteger" />
<MemberSignature Language="F#" Value="static member HashToUInt32 : ReadOnlySpan<byte> * int -> uint32" Usage="System.IO.Hashing.XxHash32.HashToUInt32 (source, seed)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>
<AttributeName Language="F#">[<System.CLSCompliant(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<param name="seed">The seed value for this hash computation. The default is zero.</param>
<summary>Computes the XxHash32 hash of the provided data.</summary>
<returns>The computed XxHash32 hash.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public override void Reset ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Reset() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.Reset" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Reset ()" />
<MemberSignature Language="F#" Value="override this.Reset : unit -> unit" Usage="xxHash32.Reset " />
<MemberSignature Language="C++ CLI" Value="public:
 override void Reset();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Resets the hash computation to the initial state.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryHash">
<MemberSignature Language="C#" Value="public static bool TryHash (ReadOnlySpan<byte> source, Span<byte> destination, out int bytesWritten, int seed = 0);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryHash(valuetype System.ReadOnlySpan`1<unsigned int8> source, valuetype System.Span`1<unsigned int8> destination, [out] int32& bytesWritten, int32 seed) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IO.Hashing.XxHash32.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryHash (source As ReadOnlySpan(Of Byte), destination As Span(Of Byte), ByRef bytesWritten As Integer, Optional seed As Integer = 0) As Boolean" />
<MemberSignature Language="F#" Value="static member TryHash : ReadOnlySpan<byte> * Span<byte> * int * int -> bool" Usage="System.IO.Hashing.XxHash32.TryHash (source, destination, bytesWritten, seed)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IO.Hashing</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="source" Type="System.ReadOnlySpan<System.Byte>" />
<Parameter Name="destination" Type="System.Span<System.Byte>" />
<Parameter Name="bytesWritten" Type="System.Int32" RefType="out" />
<Parameter Name="seed" Type="System.Int32" />
</Parameters>
<Docs>
<param name="source">The data to hash.</param>
<param name="destination">The buffer that receives the computed hash value.</param>
<param name="bytesWritten">When this method returns, contains the number of bytes written to <paramref name="destination" />.</param>
<param name="seed">The seed value for this hash computation. The default is zero.</param>
<summary>Attempts to compute the XxHash32 hash of the provided data into the provided destination.</summary>
<returns>
<see langword="true" /> if <paramref name="destination" /> is long enough to receive the computed hash value (4 bytes); otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>