Data.HashFunction.IStreamableHashFunction Interface Reference

Common interface to non-cryptographic hash functions that can be computed over a stream of data without buffering. More...

Inheritance diagram for Data.HashFunction.IStreamableHashFunction:

Collaboration diagram for Data.HashFunction.IStreamableHashFunction:

Public Member Functions
IBlockTransformer	CreateBlockTransformer ()
	Creates a new transformer that will process data and hold the internal state using this hash function's algorithm.
IHashValue	ComputeHash (Stream data)
	Computes hash value for given stream.
IHashValue	ComputeHash (Stream data, CancellationToken cancellationToken)
	Computes hash value for given stream.
Task< IHashValue >	ComputeHashAsync (Stream data)
	Computes hash value for given stream asynchronously.
Task< IHashValue >	ComputeHashAsync (Stream data, CancellationToken cancellationToken)
	Computes hash value for given stream asynchronously.
Public Member Functions inherited from Data.HashFunction.IHashFunction
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.

Additional Inherited Members
Properties inherited from Data.HashFunction.IHashFunction
int	HashSizeInBits [get]
	Size of produced hash, in bits.

Detailed Description

Common interface to non-cryptographic hash functions that can be computed over a stream of data without buffering.

Member Function Documentation

ComputeHash() [1/2]

IHashValue Data.HashFunction.IStreamableHashFunction.ComputeHash

(

Stream

data

)

Computes hash value for given stream.

Parameters

data	Stream of data to hash.

Returns

Hash value of the data.

Exceptions

ArgumentNullException	data
ArgumentException	Stream must be readable.;data
ArgumentException	Stream must be seekable for this type of hash function.;data

Implemented in Data.HashFunction.Core.StreamableHashFunctionBase.

ComputeHash() [2/2]

IHashValue Data.HashFunction.IStreamableHashFunction.ComputeHash	(	Stream	data,
		CancellationToken	cancellationToken )

Computes hash value for given stream.

Parameters

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

Returns

Hash value of the data.

Exceptions

ArgumentNullException	data
ArgumentException	Stream must be readable.;data
ArgumentException	Stream must be seekable for this type of hash function.;data
TaskCanceledException	The cancellationToken was canceled.

Implemented in Data.HashFunction.Core.StreamableHashFunctionBase.

ComputeHashAsync() [1/2]

Task< IHashValue > Data.HashFunction.IStreamableHashFunction.ComputeHashAsync

(

Stream

data

)

Computes hash value for given stream asynchronously.

Parameters

data	Stream of data to hash.

Returns

Hash value of the data.

All stream IO is done via ReadAsync.

Exceptions

ArgumentNullException	data
ArgumentException	Stream must be readable.;data
ArgumentException	Stream must be seekable for this type of hash function.;data

Implemented in Data.HashFunction.Core.StreamableHashFunctionBase.

ComputeHashAsync() [2/2]

Task< IHashValue > Data.HashFunction.IStreamableHashFunction.ComputeHashAsync	(	Stream	data,
		CancellationToken	cancellationToken )

Computes hash value for given stream asynchronously.

Parameters

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

Returns

Hash value of the data.

All stream IO is done via ReadAsync.

Exceptions

ArgumentNullException	data
ArgumentException	Stream must be readable.;data
ArgumentException	Stream must be seekable for this type of hash function.;data
TaskCanceledException	The cancellationToken was canceled.

Implemented in Data.HashFunction.Core.StreamableHashFunctionBase.

CreateBlockTransformer()

IBlockTransformer Data.HashFunction.IStreamableHashFunction.CreateBlockTransformer

(

)

Creates a new transformer that will process data and hold the internal state using this hash function's algorithm.

Returns

A new instance of IBlockTransformer that can process input iteratively and produce a final IHashValue for that input.

Implemented in Data.HashFunction.BernsteinHash.BernsteinHash_Implementation, Data.HashFunction.BernsteinHash.ModifiedBernsteinHash_Implementation, Data.HashFunction.Blake2.Blake2B_Implementation, Data.HashFunction.BuzHash.BuzHash_Implementation, Data.HashFunction.Core.StreamableHashFunctionBase, Data.HashFunction.CRC.CRC_Implementation, Data.HashFunction.ELF64.ELF64_Implementation, Data.HashFunction.FNV.FNV1_Implementation, Data.HashFunction.FNV.FNV1a_Implementation, Data.HashFunction.Jenkins.JenkinsLookup2_Implementation, Data.HashFunction.Jenkins.JenkinsOneAtATime_Implementation, Data.HashFunction.MetroHash.MetroHash128_Implementation, Data.HashFunction.MetroHash.MetroHash64_Implementation, Data.HashFunction.MurmurHash.MurmurHash3_Implementation, Data.HashFunction.Pearson.Pearson_Implementation, Data.HashFunction.SpookyHash.SpookyHashV1_Implementation, Data.HashFunction.SpookyHash.SpookyHashV2_Implementation, and Data.HashFunction.xxHash.xxHash_Implementation.

---

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

• IStreamableHashFunction.cs