Data.HashFunction.IBlockTransformer Interface Reference

An internal state of an iteratively computable hash function value. More...

Inheritance diagram for Data.HashFunction.IBlockTransformer:

Public Member Functions
IBlockTransformer	Clone ()
	Clones this transformer's internal state to a new, unassociated instance of this transformer.
void	TransformBytes (byte[] data)
	Updates the internal state of this transformer with the given data.
void	TransformBytes (byte[] data, CancellationToken cancellationToken)
	Updates the internal state of this transformer with the given data.
void	TransformBytes (byte[] data, int offset, int count)
	Updates the internal state of this transformer with the given data.
void	TransformBytes (byte[] data, int offset, int count, CancellationToken cancellationToken)
	Updates the internal state of this transformer with the given data.
void	TransformBytes (ArraySegment< byte > data)
	Updates the internal state of this transformer with the given data.
void	TransformBytes (ArraySegment< byte > data, CancellationToken cancellationToken)
	Updates the internal state of this transformer with the given data.
IHashValue	FinalizeHashValue ()
	Completes any finalization processing and returns the resulting IHashValue.
IHashValue	FinalizeHashValue (CancellationToken cancellationToken)
	Completes any finalization processing and returns the resulting IHashValue.

Detailed Description

An internal state of an iteratively computable hash function value.

Member Function Documentation

Clone()

IBlockTransformer Data.HashFunction.IBlockTransformer.Clone

(

)

Clones this transformer's internal state to a new, unassociated instance of this transformer.

Returns

A new, unassociated instance of this transformer.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

FinalizeHashValue() [1/2]

IHashValue Data.HashFunction.IBlockTransformer.FinalizeHashValue

(

)

Completes any finalization processing and returns the resulting IHashValue.

Internal state will remain unmodified, therefore this method will not invalidate future calls to any TransformBytes or FinalizeHashValue.

Exceptions

InvalidOperationException

A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

FinalizeHashValue() [2/2]

IHashValue Data.HashFunction.IBlockTransformer.FinalizeHashValue

(

CancellationToken

cancellationToken

)

Completes any finalization processing and returns the resulting IHashValue.

Parameters

cancellationToken

A CancellationToken to cease any final processing.

Internal state will remain unmodified, therefore this method will not invalidate future calls to any other TransformBytes or FinalizeHashValue.

Exceptions

TaskCanceledException	The cancellationToken was canceled.
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [1/6]

void Data.HashFunction.IBlockTransformer.TransformBytes

(

ArraySegment< byte >

data

)

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.

Exceptions

ArgumentException	data must be an ArraySegment of Count > 0.;data
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [2/6]

void Data.HashFunction.IBlockTransformer.TransformBytes	(	ArraySegment< byte >	data,
		CancellationToken	cancellationToken )

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.
cancellationToken	A CancellationToken to cease processing of the provided data.

Exceptions

ArgumentException	data must be an ArraySegment of Count > 0.;data
TaskCanceledException	The cancellationToken was canceled.
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [3/6]

void Data.HashFunction.IBlockTransformer.TransformBytes

(

byte[]

data

)

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.

Exceptions

ArgumentNullException	data
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [4/6]

void Data.HashFunction.IBlockTransformer.TransformBytes	(	byte[]	data,
		CancellationToken	cancellationToken )

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.
cancellationToken	A CancellationToken to cease processing of the provided data.

Exceptions

ArgumentNullException	data
TaskCanceledException	The cancellationToken was canceled.
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [5/6]

void Data.HashFunction.IBlockTransformer.TransformBytes	(	byte[]	data,
		int	offset,
		int	count )

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.
offset	The offset from which to begin using the data.
count	The number of bytes to use as data.

Exceptions

ArgumentNullException	data
ArgumentOutOfRangeException	offset ;Offset must be a value greater than or equal to zero and less than the length of the array minus one.
ArgumentOutOfRangeException	count ;Count must be a value greater than zero and less than the the remaining length of the array after the offset value.
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

TransformBytes() [6/6]

void Data.HashFunction.IBlockTransformer.TransformBytes	(	byte[]	data,
		int	offset,
		int	count,
		CancellationToken	cancellationToken )

Updates the internal state of this transformer with the given data.

Parameters

data	The data to process into this transformer's internal state.
offset	The offset from which to begin using the data.
count	The number of bytes to use as data.
cancellationToken	A CancellationToken to cease processing of the provided data.

Exceptions

ArgumentNullException	data
ArgumentOutOfRangeException	offset ;Offset must be a value greater than or equal to zero and less than the length of the array minus one.
ArgumentOutOfRangeException	count ;Count must be a value greater than zero and less than the the remaining length of the array after the offset value.
TaskCanceledException	The cancellationToken was canceled.
InvalidOperationException	A previous transformation cancellation has resulted in an undefined internal state.

Implemented in Data.HashFunction.Core.BlockTransformerBase< TSelf >.

---

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

• IBlockTransformer.cs