Edit

Share via


XxHash3 Class

Definition

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

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

HashLengthInBytes

Gets the number of bytes produced from this hash algorithm.

(Inherited from NonCryptographicHashAlgorithm)

Methods

Append(Byte[])

Appends the contents of source to the data already processed for the current hash computation.

(Inherited from NonCryptographicHashAlgorithm)
Append(ReadOnlySpan<Byte>)

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)
Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetCurrentHash()

Gets the current computed hash value without modifying accumulated state.

(Inherited from NonCryptographicHashAlgorithm)
GetCurrentHash(Span<Byte>)

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<Byte>)

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<Byte>)

Writes the computed hash value to destination then clears the accumulated state.

(Inherited from NonCryptographicHashAlgorithm)
GetHashAndResetCore(Span<Byte>)

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)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
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<Byte>, Int64)

Computes the XXH3 hash of the provided source data using the optionally provided seed.

Hash(ReadOnlySpan<Byte>, Span<Byte>, Int64)

Computes the XXH3 hash of the provided source data into the provided destination using the optionally provided seed.

HashToUInt64(ReadOnlySpan<Byte>, Int64)

Computes the XXH3 hash of the provided data.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
Reset()

Resets the hash computation to the initial state.

ToString()

Returns a string that represents the current object.

(Inherited from Object)
TryGetCurrentHash(Span<Byte>, Int32)

Attempts to write the computed hash value to destination without modifying accumulated state.

(Inherited from NonCryptographicHashAlgorithm)
TryGetHashAndReset(Span<Byte>, Int32)

Attempts to write the computed hash value to destination. If successful, clears the accumulated state.

(Inherited from NonCryptographicHashAlgorithm)
TryHash(ReadOnlySpan<Byte>, Span<Byte>, Int32, Int64)

Attempts to compute the XXH3 hash of the provided source data into the provided destination using the optionally provided seed.

Applies to