Class ByteUtil

Utility methods to deal with Byte arrays.

Inheritance

Object

ByteUtil

Inherited Members

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Libplanet

Assembly: Libplanet.dll

Syntax

public static class ByteUtil

Methods

CalculateHashCode(Byte[])

Calculates a deterministic hash code from a given bytes. It is mostly used to implement GetHashCode() method.

Declaration

[Pure]
public static int CalculateHashCode(byte[] bytes)

Parameters

Type	Name	Description
Byte[]	bytes	A Byte array, which completely determines (or encodes) an object, to calculate a hash code.

Returns

Type	Description
Int32	A hash code determined from the given bytes. For equivalent bytes, the same hash code is returned. It must not be null.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the given bytes is null.

Hex(in ImmutableArray<Byte>)

Renders a hexadecimal string from a Byte array.

Declaration

[Pure]
public static string Hex(in ImmutableArray<byte> bytes)

Parameters

Type	Name	Description
ImmutableArray<Byte>	bytes	A Byte array to renders the corresponding hexadecimal string. It must not be null.

Returns

Type	Description
String	A hexadecimal string which encodes the given bytes.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the given bytes is null.

Hex(Byte[])

Renders a hexadecimal string from a Byte array.

Declaration

[Pure]
public static string Hex(byte[] bytes)

Parameters

Type	Name	Description
Byte[]	bytes	A Byte array to renders the corresponding hexadecimal string. It must not be null.

Returns

Type	Description
String	A hexadecimal string which encodes the given bytes.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the given bytes is null.

ParseHex(String)

Converts a hexadecimal string to a Byte array.

Declaration

[Pure]
public static byte[] ParseHex(string hex)

Parameters

Type	Name	Description
String	hex	A String which encodes Bytes in hexadecimal. Its length must be zero or an even number. It must not be null.

Returns

Type	Description
Byte[]	A Byte array that the given hex string represented in hexadecimal. It lengthens the half of the given hex string.

Exceptions

Type	Condition
ArgumentNullException	Thrown when the given hex string is null.
ArgumentOutOfRangeException	Thrown when the length of the given hex string is an odd number.
FormatException	Thrown when the given hex string is not a valid hexadecimal string.

Satisfies(IReadOnlyList<Byte>, Int64)

Tests if a hash digest is less than the target computed for the given difficulty).

Declaration

[Pure]
public static bool Satisfies(IReadOnlyList<byte> hashDigest, long difficulty)

Parameters

Type	Name	Description
IReadOnlyList<Byte>	hashDigest	A hash digest to test.
Int64	difficulty	The difficulty to compute target number.

Returns

Type	Description
Boolean	true only if a digest is less than the target computed for the given difficulty). If difficulty is 0 it always returns true.

TimingSafelyCompare(IReadOnlyList<Byte>, IReadOnlyList<Byte>)

Timing safe comparision of two byte arrays.

Declaration

[Pure]
public static bool TimingSafelyCompare(IReadOnlyList<byte> left, IReadOnlyList<byte> right)

Parameters

Type	Name	Description
IReadOnlyList<Byte>	left	A byte array.
IReadOnlyList<Byte>	right	Another byte array.

Returns

Type	Description
Boolean	true iff two byte arrays have the exactly same contents.

Remarks

In case of two byte arrays do not have the same length, it tries to keep the timing dependent on the length of the shorter one.