Data.HashFunction.IHashFunction Interface Reference

Common interface to non-cryptographic hash functions. More...

Inheritance diagram for Data.HashFunction.IHashFunction:

Public Member Functions
IHashValue	ComputeHash (byte[] data)
	Computes hash value for given byte array.
IHashValue	ComputeHash (byte[] data, CancellationToken cancellationToken)
	Computes hash value for given byte array.
IHashValue	ComputeHash (byte[] data, int offset, int count)
	Computes hash value for given byte array.
IHashValue	ComputeHash (byte[] data, int offset, int count, CancellationToken cancellationToken)
	Computes hash value for given byte array.
IHashValue	ComputeHash (ArraySegment< byte > data)
	Computes hash value for given array segment.
IHashValue	ComputeHash (ArraySegment< byte > data, CancellationToken cancellationToken)
	Computes hash value for given array segment.

Properties
int	HashSizeInBits [get]
	Size of produced hash, in bits.

Detailed Description

Common interface to non-cryptographic hash functions.

Member Function Documentation

ComputeHash() [1/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash

(

ArraySegment< byte >

data

)

Computes hash value for given array segment.

Parameters

data	Array segment of data to hash.

Returns

Hash value of the data.

Implemented in Data.HashFunction.Core.HashFunctionBase.

ComputeHash() [2/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash	(	ArraySegment< byte >	data,
		CancellationToken	cancellationToken )

Computes hash value for given array segment.

Parameters

data	Array segment of data to hash.
cancellationToken	A CancellationToken to observe while calculating the hash value.

Returns

Hash value of the data.

Exceptions

TaskCanceledException

The cancellationToken was canceled.

Implemented in Data.HashFunction.Core.HashFunctionBase.

ComputeHash() [3/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash

(

byte[]

data

)

Computes hash value for given byte array.

Parameters

data	Array of data to hash.

Returns

Hash value of the data.

Exceptions

ArgumentNullException

data

Implemented in Data.HashFunction.Core.HashFunctionBase.

Here is the caller graph for this function:

ComputeHash() [4/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash	(	byte[]	data,
		CancellationToken	cancellationToken )

Computes hash value for given byte array.

Parameters

data	Array of data to hash.
cancellationToken	A CancellationToken to observe while calculating the hash value.

Returns

Hash value of the data.

Exceptions

ArgumentNullException	data
TaskCanceledException	The cancellationToken was canceled.

Implemented in Data.HashFunction.Core.HashFunctionBase.

ComputeHash() [5/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash	(	byte[]	data,
		int	offset,
		int	count )

Computes hash value for given byte array.

Parameters

data	Array of data to hash.
offset	The offset from which to begin using the data.
count	The number of bytes to use as data.

Returns

Hash value of the data.

Exceptions

ArgumentNullException	data
ArgumentOutOfRangeException	offset ;Offset must be a value greater than or equal to zero and less than or equal to the length of the array.
ArgumentOutOfRangeException	count ;Count must be a value greater than or equal to zero and less than the the remaining length of the array after the offset value.

Implemented in Data.HashFunction.Core.HashFunctionBase.

ComputeHash() [6/6]

IHashValue Data.HashFunction.IHashFunction.ComputeHash	(	byte[]	data,
		int	offset,
		int	count,
		CancellationToken	cancellationToken )

Computes hash value for given byte array.

Parameters

data	Array of data to hash.
offset	The offset from which to begin using the data.
count	The number of bytes to use as data.
cancellationToken	A CancellationToken to observe while calculating the hash value.

Returns

Hash value of the data.

Exceptions

ArgumentNullException	data
ArgumentOutOfRangeException	offset ;Offset must be a value greater than or equal to zero and less than or equal to the length of the array.
ArgumentOutOfRangeException	count ;Count must be a value greater than or equal to zero and less than the the remaining length of the array after the offset value.
TaskCanceledException	The cancellationToken was canceled.

Implemented in Data.HashFunction.Core.HashFunctionBase.

Property Documentation

HashSizeInBits

int Data.HashFunction.IHashFunction.HashSizeInBits

get

Size of produced hash, in bits.

The size of the hash, in bits.

Implemented in Data.HashFunction.BernsteinHash.BernsteinHash_Implementation, Data.HashFunction.BernsteinHash.ModifiedBernsteinHash_Implementation, Data.HashFunction.Blake2.Blake2B_Implementation, Data.HashFunction.Blake3.Blake3_Implementation, Data.HashFunction.BuzHash.BuzHash_Implementation, Data.HashFunction.CityHash.CityHash_Implementation, Data.HashFunction.Core.HashFunctionBase, Data.HashFunction.CRC.CRC_Implementation, Data.HashFunction.ELF64.ELF64_Implementation, Data.HashFunction.FarmHash.FarmHashFingerprint128_Implementation, Data.HashFunction.FarmHash.FarmHashFingerprint32_Implementation, Data.HashFunction.FarmHash.FarmHashFingerprint64_Implementation, Data.HashFunction.FNV.FNV1Base, Data.HashFunction.HashAlgorithm.HashAlgorithmWrapper_Implementation, Data.HashFunction.Jenkins.JenkinsLookup2_Implementation, Data.HashFunction.Jenkins.JenkinsLookup3_Implementation, Data.HashFunction.Jenkins.JenkinsOneAtATime_Implementation, Data.HashFunction.MetroHash.MetroHash128_Implementation, Data.HashFunction.MetroHash.MetroHash64_Implementation, Data.HashFunction.MurmurHash.MurmurHash1_Implementation, Data.HashFunction.MurmurHash.MurmurHash2_Implementation, Data.HashFunction.MurmurHash.MurmurHash3_Implementation, Data.HashFunction.Pearson.Pearson_Implementation, Data.HashFunction.SpookyHash.SpookyHashV1_Implementation, Data.HashFunction.SpookyHash.SpookyHashV2_Implementation, Data.HashFunction.Test._Mocks.HashFunctionImpl, and Data.HashFunction.xxHash.xxHash_Implementation.

---

The documentation for this interface was generated from the following file:

• IHashFunction.cs