add offline packages
This commit is contained in:
master
581
offline/packages/system.io.hashing/6.0.1/lib/net6.0/System.IO.Hashing.xml
vendored
Normal file
581
offline/packages/system.io.hashing/6.0.1/lib/net6.0/System.IO.Hashing.xml
vendored
Normal file
@@ -0,0 +1,581 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>System.IO.Hashing</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:System.IO.Hashing.Crc32">
|
||||
<summary>
|
||||
Provides an implementation of the CRC-32 algorithm, as used in
|
||||
ITU-T V.42 and IEEE 802.3.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
This implementation emits the answer in the Little Endian byte order so that
|
||||
the CRC residue relationship (CRC(message concat CRC(message))) is a fixed value) holds.
|
||||
For CRC-32 this stable output is the byte sequence <c>{ 0x1C, 0xDF, 0x44, 0x21 }</c>,
|
||||
the Little Endian representation of <c>0x2144DF1C</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are multiple, incompatible, definitions of a 32-bit cyclic redundancy
|
||||
check (CRC) algorithm. When interoperating with another system, ensure that you
|
||||
are using the same definition. The definition used by this implementation is not
|
||||
compatible with the cyclic redundancy check described in ITU-T I.363.5.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.Crc32"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.Append(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.Reset">
|
||||
<summary>
|
||||
Resets the hash computation to the initial state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.GetCurrentHashCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.GetHashAndResetCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
then clears the accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.Hash(System.Byte[])">
|
||||
<summary>
|
||||
Computes the CRC-32 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The CRC-32 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.Hash(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Computes the CRC-32 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The CRC-32 hash of the provided data.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
|
||||
<summary>
|
||||
Attempts to compute the CRC-32 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives the number of bytes written to <paramref name="destination"/>.
|
||||
</param>
|
||||
<returns>
|
||||
<see langword="true"/> if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value (4 bytes); otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc32.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>
|
||||
Computes the CRC-32 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Hashing.Crc64">
|
||||
<summary>
|
||||
Provides an implementation of the CRC-64 algorithm as described in ECMA-182, Annex B.
|
||||
</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
This implementation emits the answer in the Big Endian byte order so that
|
||||
the CRC residue relationship (CRC(message concat CRC(message))) is a fixed value) holds.
|
||||
For CRC-64 this stable output is the byte sequence
|
||||
<c>{ 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 }</c>.
|
||||
</para>
|
||||
<para>
|
||||
There are multiple, incompatible, definitions of a 64-bit cyclic redundancy
|
||||
check (CRC) algorithm. When interoperating with another system, ensure that you
|
||||
are using the same definition. The definition used by this implementation is not
|
||||
compatible with the cyclic redundancy check described in ISO 3309.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.Crc64"/> class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.Append(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.Reset">
|
||||
<summary>
|
||||
Resets the hash computation to the initial state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.GetCurrentHashCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.GetHashAndResetCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
then clears the accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.Hash(System.Byte[])">
|
||||
<summary>
|
||||
Computes the CRC-64 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The CRC-64 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.Hash(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Computes the CRC-64 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The CRC-64 hash of the provided data.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@)">
|
||||
<summary>
|
||||
Attempts to compute the CRC-64 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives the number of bytes written to <paramref name="destination"/>.
|
||||
</param>
|
||||
<returns>
|
||||
<see langword="true"/> if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value (8 bytes); otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.Crc64.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte})">
|
||||
<summary>
|
||||
Computes the CRC-64 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Hashing.XxHash32">
|
||||
<summary>
|
||||
Provides an implementation of the XxHash32 algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32"/> class.
|
||||
</summary>
|
||||
<remarks>
|
||||
The XxHash32 algorithm supports an optional seed value.
|
||||
Instances created with this constructor use the default seed, zero.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash32"/> class with
|
||||
a specified seed.
|
||||
</summary>
|
||||
<param name="seed">
|
||||
The hash seed value for computations from this instance.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Reset">
|
||||
<summary>
|
||||
Resets the hash computation to the initial state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Append(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.GetCurrentHashCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Hash(System.Byte[])">
|
||||
<summary>
|
||||
Computes the XxHash32 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The XxHash32 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Hash(System.Byte[],System.Int32)">
|
||||
<summary>
|
||||
Computes the XxHash32 hash of the provided data using the provided seed.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="seed">The seed value for this hash computation.</param>
|
||||
<returns>The XxHash32 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Int32)">
|
||||
<summary>
|
||||
Computes the XxHash32 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="seed">The seed value for this hash computation. The default is zero.</param>
|
||||
<returns>The XxHash32 hash of the provided data.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int32)">
|
||||
<summary>
|
||||
Attempts to compute the XxHash32 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives 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>
|
||||
<returns>
|
||||
<see langword="true"/> if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value (4 bytes); otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash32.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32)">
|
||||
<summary>
|
||||
Computes the XxHash32 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<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>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Hashing.XxHash64">
|
||||
<summary>
|
||||
Provides an implementation of the XxHash64 algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.#ctor">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash64"/> class.
|
||||
</summary>
|
||||
<remarks>
|
||||
The XxHash64 algorithm supports an optional seed value.
|
||||
Instances created with this constructor use the default seed, zero.
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.#ctor(System.Int64)">
|
||||
<summary>
|
||||
Initializes a new instance of the <see cref="T:System.IO.Hashing.XxHash64"/> class with
|
||||
a specified seed.
|
||||
</summary>
|
||||
<param name="seed">
|
||||
The hash seed value for computations from this instance.
|
||||
</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Reset">
|
||||
<summary>
|
||||
Resets the hash computation to the initial state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Append(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.GetCurrentHashCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Hash(System.Byte[])">
|
||||
<summary>
|
||||
Computes the XxHash64 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<returns>The XxHash64 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Hash(System.Byte[],System.Int64)">
|
||||
<summary>
|
||||
Computes the XxHash64 hash of the provided data using the provided seed.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="seed">The seed value for this hash computation.</param>
|
||||
<returns>The XxHash64 hash of the provided data.</returns>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Hash(System.ReadOnlySpan{System.Byte},System.Int64)">
|
||||
<summary>
|
||||
Computes the XxHash64 hash of the provided data.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="seed">The seed value for this hash computation. The default is zero.</param>
|
||||
<returns>The XxHash64 hash of the provided data.</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.TryHash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int32@,System.Int64)">
|
||||
<summary>
|
||||
Attempts to compute the XxHash64 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<param name="source">The data to hash.</param>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives 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>
|
||||
<returns>
|
||||
<see langword="true"/> if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value (4 bytes); otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.XxHash64.Hash(System.ReadOnlySpan{System.Byte},System.Span{System.Byte},System.Int64)">
|
||||
<summary>
|
||||
Computes the XxHash64 hash of the provided data into the provided destination.
|
||||
</summary>
|
||||
<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>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="T:System.IO.Hashing.NonCryptographicHashAlgorithm">
|
||||
<summary>
|
||||
Represents a non-cryptographic hash algorithm.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes">
|
||||
<summary>
|
||||
Gets the number of bytes produced from this hash algorithm.
|
||||
</summary>
|
||||
<value>The number of bytes produced from this hash algorithm.</value>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.#ctor(System.Int32)">
|
||||
<summary>
|
||||
Called from constructors in derived classes to initialize the
|
||||
<see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class.
|
||||
</summary>
|
||||
<param name="hashLengthInBytes">
|
||||
The number of bytes produced from this hash algorithm.
|
||||
</param>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">
|
||||
<paramref name="hashLengthInBytes"/> is less than 1.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.ReadOnlySpan{System.Byte})">
|
||||
<summary>
|
||||
When overridden in a derived class,
|
||||
appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Reset">
|
||||
<summary>
|
||||
When overridden in a derived class,
|
||||
resets the hash computation to the initial state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHashCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
When overridden in a derived class,
|
||||
writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<remarks>
|
||||
<para>
|
||||
Implementations of this method must write exactly
|
||||
<see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> bytes to <paramref name="destination"/>.
|
||||
Do not assume that the buffer was zero-initialized.
|
||||
</para>
|
||||
<para>
|
||||
The <see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class validates the
|
||||
size of the buffer before calling this method, and slices the span
|
||||
down to be exactly <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> in length.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.Byte[])">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="source"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="source">The data to process.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="source"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Append(System.IO.Stream)">
|
||||
<summary>
|
||||
Appends the contents of <paramref name="stream"/> to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="stream">The data to process.</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="stream"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
<seealso cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.AppendAsync(System.IO.Stream,System.Threading.CancellationToken)"/>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.AppendAsync(System.IO.Stream,System.Threading.CancellationToken)">
|
||||
<summary>
|
||||
Asychronously reads the contents of <paramref name="stream"/>
|
||||
and appends them to the data already
|
||||
processed for the current hash computation.
|
||||
</summary>
|
||||
<param name="stream">The data to process.</param>
|
||||
<param name="cancellationToken">
|
||||
The token to monitor for cancellation requests.
|
||||
The default value is <see cref="P:System.Threading.CancellationToken.None"/>.
|
||||
</param>
|
||||
<exception cref="T:System.ArgumentNullException">
|
||||
<paramref name="stream"/> is <see langword="null"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash">
|
||||
<summary>
|
||||
Gets the current computed hash value without modifying accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.TryGetCurrentHash(System.Span{System.Byte},System.Int32@)">
|
||||
<summary>
|
||||
Attempts to write the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives the number of bytes written to <paramref name="destination"/>.
|
||||
</param>
|
||||
<returns>
|
||||
<see langword="true"/> if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value; otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
without modifying accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>,
|
||||
which is always <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="destination"/> is shorter than <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset">
|
||||
<summary>
|
||||
Gets the current computed hash value and clears the accumulated state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.TryGetHashAndReset(System.Span{System.Byte},System.Int32@)">
|
||||
<summary>
|
||||
Attempts to write the computed hash value to <paramref name="destination"/>.
|
||||
If successful, clears the accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<param name="bytesWritten">
|
||||
On success, receives the number of bytes written to <paramref name="destination"/>.
|
||||
</param>
|
||||
<returns>
|
||||
<see langword="true"/> and clears the accumulated state
|
||||
if <paramref name="destination"/> is long enough to receive
|
||||
the computed hash value; otherwise, <see langword="false"/>.
|
||||
</returns>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
then clears the accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<returns>
|
||||
The number of bytes written to <paramref name="destination"/>,
|
||||
which is always <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
|
||||
</returns>
|
||||
<exception cref="T:System.ArgumentException">
|
||||
<paramref name="destination"/> is shorter than <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/>.
|
||||
</exception>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndResetCore(System.Span{System.Byte})">
|
||||
<summary>
|
||||
Writes the computed hash value to <paramref name="destination"/>
|
||||
then clears the accumulated state.
|
||||
</summary>
|
||||
<param name="destination">The buffer that receives the computed hash value.</param>
|
||||
<remarks>
|
||||
<para>
|
||||
Implementations of this method must write exactly
|
||||
<see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> bytes to <paramref name="destination"/>.
|
||||
Do not assume that the buffer was zero-initialized.
|
||||
</para>
|
||||
<para>
|
||||
The <see cref="T:System.IO.Hashing.NonCryptographicHashAlgorithm"/> class validates the
|
||||
size of the buffer before calling this method, and slices the span
|
||||
down to be exactly <see cref="P:System.IO.Hashing.NonCryptographicHashAlgorithm.HashLengthInBytes"/> in length.
|
||||
</para>
|
||||
<para>
|
||||
The default implementation of this method calls
|
||||
<see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHashCore(System.Span{System.Byte})"/> followed by <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.Reset"/>.
|
||||
Overrides of this method do not need to call either of those methods,
|
||||
but must ensure that the caller cannot observe a difference in behavior.
|
||||
</para>
|
||||
</remarks>
|
||||
</member>
|
||||
<member name="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashCode">
|
||||
<summary>
|
||||
This method is not supported and should not be called.
|
||||
Call <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetCurrentHash"/> or <see cref="M:System.IO.Hashing.NonCryptographicHashAlgorithm.GetHashAndReset"/>
|
||||
instead.
|
||||
</summary>
|
||||
<returns>This method will always throw a <see cref="T:System.NotSupportedException"/>.</returns>
|
||||
<exception cref="T:System.NotSupportedException">In all cases.</exception>
|
||||
</member>
|
||||
<member name="P:System.SR.Argument_DestinationTooShort">
|
||||
<summary>Destination is too short.</summary>
|
||||
</member>
|
||||
<member name="P:System.SR.NotSupported_GetHashCode">
|
||||
<summary>The GetHashCode method is not supported on this object. Use GetCurrentHash or GetHashAndReset to retrieve the hash code computed by this object.</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user