XxHash3 Class (System.IO.Hashing) (original) (raw)

Definition

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides an implementation of the XXH3 hash algorithm for generating a 64-bit hash.

public ref class XxHash3 sealed : System::IO::Hashing::NonCryptographicHashAlgorithm
public sealed class XxHash3 : System.IO.Hashing.NonCryptographicHashAlgorithm
type XxHash3 = class
    inherit NonCryptographicHashAlgorithm
Public NotInheritable Class XxHash3
Inherits NonCryptographicHashAlgorithm

Inheritance

Remarks

For methods that persist the computed numerical hash value as bytes, the value is written in the Big Endian byte order.

Constructors

Name Description
XxHash3() Initializes a new instance of the XxHash3 class using the default seed value 0.
XxHash3(Int64) Initializes a new instance of the XxHash3 class using the specified seed.

Properties

Name Description
HashLengthInBytes Gets the number of bytes produced from this hash algorithm. (Inherited from NonCryptographicHashAlgorithm)

Methods

Name Description
Append(Byte[]) Appends the contents of source to the data already processed for the current hash computation. (Inherited from NonCryptographicHashAlgorithm)
Append(ReadOnlySpan) Appends the contents of source to the data already processed for the current hash computation.
Append(Stream) Appends the contents of stream to the data already processed for the current hash computation. (Inherited from NonCryptographicHashAlgorithm)
AppendAsync(Stream, CancellationToken) Asychronously reads the contents of stream and appends them to the data already processed for the current hash computation. (Inherited from NonCryptographicHashAlgorithm)
Clone() Returns a clone of the current instance, with a copy of the current instance's internal state.
GetCurrentHash() Gets the current computed hash value without modifying accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetCurrentHash(Span) Writes the computed hash value to destination without modifying accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetCurrentHashAsUInt64() Gets the current computed hash value without modifying accumulated state.
GetCurrentHashCore(Span) When overridden in a derived class, writes the computed hash value to destination without modifying accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetHashAndReset() Gets the current computed hash value and clears the accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetHashAndReset(Span) Writes the computed hash value to destination then clears the accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetHashAndResetCore(Span) Writes the computed hash value to destination then clears the accumulated state. (Inherited from NonCryptographicHashAlgorithm)
GetHashCode() Obsolete. This method is not supported and should not be called. Call GetCurrentHash() or GetHashAndReset() instead. (Inherited from NonCryptographicHashAlgorithm)
Hash(Byte[], Int64) Computes the XXH3 hash of the provided data using the provided seed.
Hash(Byte[]) Computes the XXH3 hash of the provided source data.
Hash(ReadOnlySpan, Int64) Computes the XXH3 hash of the provided source data using the optionally provided seed.
Hash(ReadOnlySpan, Span, Int64) Computes the XXH3 hash of the provided source data into the provided destination using the optionally provided seed.
HashToUInt64(ReadOnlySpan, Int64) Computes the XXH3 hash of the provided data.
Reset() Resets the hash computation to the initial state.
TryGetCurrentHash(Span, Int32) Attempts to write the computed hash value to destination without modifying accumulated state. (Inherited from NonCryptographicHashAlgorithm)
TryGetHashAndReset(Span, Int32) Attempts to write the computed hash value to destination. If successful, clears the accumulated state. (Inherited from NonCryptographicHashAlgorithm)
TryHash(ReadOnlySpan, Span, Int32, Int64) Attempts to compute the XXH3 hash of the provided source data into the provided destination using the optionally provided seed.

Applies to