Digest

Digest

class Digest

A 32-byte Blake2b256 hash output.

BCS

A Digest's BCS serialized form is defined by the following:

digest = %d32 32OCTET

Due to historical reasons, even though a Digest has a fixed-length of 32, IOTA's binary representation of a Digest is prefixed with its length meaning its serialized binary form (in bcs) is 33 bytes long vs a more compact 32 bytes.

debugDescription

var debugDescription: String { get }

A textual representation of this instance, suitable for debugging.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(reflecting:) initializer. This initializer works with any type, and uses the custom debugDescription property for types that conform to CustomDebugStringConvertible:

struct Point: CustomDebugStringConvertible {
    let x: Int, y: Int

    var debugDescription: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(reflecting: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's debugDescription property.

description

var description: String { get }

A textual representation of this instance.

Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(describing:) initializer. This initializer works with any type, and uses the custom description property for types that conform to CustomStringConvertible:

struct Point: CustomStringConvertible {
    let x: Int, y: Int

    var description: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"

The conversion of p to a string in the assignment to s uses the Point type's description property.

hash(into:)

func hash(into hasher: inout Hasher)

Hashes the essential components of this value by feeding them into the given hasher.

Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type's == operator implementation. Call hasher.combine(_:) with each of these components.

• Important: In your implementation of hash(into:), don't call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

• Parameter hasher: The hasher to use when combining the components of this instance.

nextLexicographical()

func nextLexicographical() -> Digest

Returns the next digest in byte-increasing order.

nextLexicographicalOpt()

func nextLexicographicalOpt() -> Digest?

Returns the next digest in byte-increasing order, or None if the result would overflow.

toBase58()

func toBase58() -> String

toBytes()

func toBytes() -> Data

fromBase58(base58:)

static func fromBase58(base58: String) throws -> Digest

fromBytes(bytes:)

static func fromBytes(bytes: Data) throws -> Digest

random()

static func random() -> Digest

!=(_:_:)

static func != (lhs: Self, rhs: Self) -> Bool

Returns a Boolean value indicating whether two values are not equal.

Inequality is the inverse of equality. For any values a and b, a != b implies that a == b is false.

This is the default implementation of the not-equal-to operator (!=) for any type that conforms to Equatable.

• Parameters:
  • lhs: A value to compare.
  • rhs: Another value to compare.

==(_:_:)

static func == (self: Digest, other: Digest) -> Bool

Returns a Boolean value indicating whether two values are equal.

Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

• Parameters:
  • lhs: A value to compare.
  • rhs: Another value to compare.