Data.HashFunction 3.1.1
DHF
Loading...
Searching...
No Matches
Data.HashFunction.IHashValue Interface Reference

Common interface to represent a hash value. More...

+ Inheritance diagram for Data.HashFunction.IHashValue:
+ Collaboration diagram for Data.HashFunction.IHashValue:

Public Member Functions

BitArray AsBitArray ()
 Converts the hash value to a bit array.
 
string AsHexString ()
 Converts the hash value to a hexadecimal string.
 
string AsHexString (bool uppercase)
 Converts the hash value to a hexadecimal string.
 
string AsBase64String ()
 Converts the hash value to a the base64 string.
 

Properties

int BitLength [get]
 Gets the length of the hash value in bits.
 
byte[] Hash [get]
 Gets resulting byte array.
 

Detailed Description

Common interface to represent a hash value.

Member Function Documentation

◆ AsBase64String()

string Data.HashFunction.IHashValue.AsBase64String ( )

Converts the hash value to a the base64 string.

Returns
A base64 string representing this hash value.

Implemented in Data.HashFunction.Core.Utilities.HashValue.

◆ AsBitArray()

BitArray Data.HashFunction.IHashValue.AsBitArray ( )

Converts the hash value to a bit array.

Returns
A BitArray instance to represent this hash value.

Implemented in Data.HashFunction.Core.Utilities.HashValue.

◆ AsHexString() [1/2]

string Data.HashFunction.IHashValue.AsHexString ( )

Converts the hash value to a hexadecimal string.

Returns
A hex string representing this hash value.

Implemented in Data.HashFunction.Core.Utilities.HashValue.

◆ AsHexString() [2/2]

string Data.HashFunction.IHashValue.AsHexString ( bool uppercase)

Converts the hash value to a hexadecimal string.

Parameters
uppercasetrue if the result should use uppercase hex values; otherwise false.
Returns
A hex string representing this hash value.

Implemented in Data.HashFunction.Core.Utilities.HashValue.

Property Documentation

◆ BitLength

int Data.HashFunction.IHashValue.BitLength
get

Gets the length of the hash value in bits.

The length of the hash value in bits.

Implemented in Data.HashFunction.Core.Utilities.HashValue.

◆ Hash

byte [] Data.HashFunction.IHashValue.Hash
get

Gets resulting byte array.

The hash value.

Implementations should coerce the input hash value to be BitLength size in bits.

Implemented in Data.HashFunction.Core.Utilities.HashValue.


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