Struct HashDigest<T>

A value type to represent digest bytes determined by a . For more type safety, it takes a type parameter T of .

Implements
ISerializable
IEquatable<HashDigest<T>>
Namespace: Libplanet
Assembly: Libplanet.dll
Syntax
public readonly struct HashDigest<T> : ISerializable, IEquatable<HashDigest<T>> where T : HashAlgorithm
Type Parameters
Name Description
T

A which corresponds to a digest. This determines Size of a digest.

Constructors

| Improve this Doc View Source

HashDigest(in ImmutableArray<Byte>)

Converts an immutable array into a HashDigest<T>.

Declaration
public HashDigest(in ImmutableArray<byte> hashDigest)
Parameters
Type Name Description
ImmutableArray<Byte> hashDigest

An immutable array that encodes a HashDigest<T>. It must not be null, and its must be the same to Size.
| Improve this Doc View Source

HashDigest(Byte[])

Converts a array into a HashDigest<T>.

Declaration
public HashDigest(byte[] hashDigest)
Parameters
Type Name Description
Byte[] hashDigest

A array that encodes a HashDigest<T>. It must not be null, and its must be the same to Size.

Fields

| Improve this Doc View Source

Size

The fixed, and valid of a array of every digest.

This varies depending upon what is used for T. For example, if T is Size is 20, and if it is 32.

Declaration
public static readonly int Size
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

ByteArray

A bare immutable array of the digest.

Declaration
public readonly ImmutableArray<byte> ByteArray { get; }
Property Value
Type Description
ImmutableArray<Byte>
Remarks

It is immutable. For a mutable array, use ToByteArray() method instead.

See Also

Methods

| Improve this Doc View Source

DeriveFrom(ImmutableArray<Byte>)

Computes a hash digest of the algorithm T from the given input bytes.

Declaration
public static HashDigest<T> DeriveFrom(ImmutableArray<byte> input)
Parameters
Type Name Description
ImmutableArray<Byte> input

The bytes to compute its hash.
Returns
Type Description
HashDigest<T>

The hash digest derived from input.
| Improve this Doc View Source

DeriveFrom(ReadOnlySpan<Byte>)

Computes a hash digest of the algorithm T from the given input bytes.

Declaration
public static HashDigest<T> DeriveFrom(ReadOnlySpan<byte> input)
Parameters
Type Name Description
ReadOnlySpan<Byte> input

The bytes to compute its hash.
Returns
Type Description
HashDigest<T>

The hash digest derived from input.
| Improve this Doc View Source

DeriveFrom(Byte[])

Computes a hash digest of the algorithm T from the given input bytes.

Declaration
public static HashDigest<T> DeriveFrom(byte[] input)
Parameters
Type Name Description
Byte[] input

The bytes to compute its hash.
Returns
Type Description
HashDigest<T>

The hash digest derived from input.
| Improve this Doc View Source

Equals(HashDigest<T>)

Declaration
public readonly bool Equals(HashDigest<T> other)
Parameters
Type Name Description
HashDigest<T> other
Returns
Type Description
Boolean
| Improve this Doc View Source

Equals(Nullable<Object>)

Declaration
public override readonly bool Equals(object? obj)
Parameters
Type Name Description
Nullable<Object> obj
Returns
Type Description
Boolean
| Improve this Doc View Source

FromString(String)

Converts a given hexadecimal representation of a digest into a HashDigest<T> object.

This is an inverse function of ToString() method.

Declaration
public static HashDigest<T> FromString(string hexDigest)
Parameters
Type Name Description
String hexDigest

A hexadecimal representation of a HashDigest<T>.
Returns
Type Description
HashDigest<T>

A corresponding HashDigest<T> value.
See Also
| Improve this Doc View Source

GetHashCode()

Declaration
public override readonly int GetHashCode()
Returns
Type Description
Int32
| Improve this Doc View Source

GetObjectData(SerializationInfo, StreamingContext)

Declaration
public readonly void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type Name Description
SerializationInfo info
StreamingContext context
| Improve this Doc View Source

ToByteArray()

Gets a bare mutable array of the digest.

Declaration
public readonly byte[] ToByteArray()
Returns
Type Description
Byte[]

A new mutable array of the digest. Since a returned array is created every time the method is called, any mutations on that array does not affect to the digest object.
See Also
| Improve this Doc View Source

ToString()

Gets a hexadecimal representation of a digest.

This is an inverse function of FromString(String).

Declaration
public override readonly string ToString()
Returns
Type Description
String

A hexadecimal representation of a digest.
See Also

Implements

ISerializable
IEquatable<>