Skip to main content

ModuleMetadata

ModuleMetadata​

class ModuleMetadata

A typed view of an on-chain 0x2::module_metadata::ModuleMetadata object, the per-module key-value store owned by a package's PackageMetadataV1.

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.

id()​

func id() -> ObjectId

The object's ID.

size()​

func size() -> UInt64

The number of key-value pairs stored in the metadata's dynamic fields. The entries themselves (e.g. the view-function names) live in dynamic fields, not in this object's contents.

tryFromBcs(bytes:)​

static func tryFromBcs(bytes: Data) throws -> ModuleMetadata

Decode from BCS bytes, without validating the on-chain type tag.

tryFromObject(object:)​

static func tryFromObject(object: Object) throws -> ModuleMetadata

Decode from an on-chain object, validating its Move type tag.