Skip to main content

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.

Extends

  • UniffiAbstractObject

Implements

Properties

[destructorGuardSymbol]

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]

readonly [uniffiTypeNameSymbol]: "ModuleMetadata" = "ModuleMetadata";

Methods

id()

id(): ObjectIdLike;

The object's ID.

Returns

ObjectIdLike

Implementation of

ModuleMetadataLike.id


size()

size(): bigint;

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.

Returns

bigint

Implementation of

ModuleMetadataLike.size


toDebugString()

toDebugString(): string;

Returns

string


toString()

toString(): string;

Returns a string representation of an object.

Returns

string


uniffiDestroy()

uniffiDestroy(): void;

Explicitly tell Rust to destroy the native peer that backs this object.

Once this method has been called, any following method calls will throw an error.

Can be called more than once.

Returns

void

Overrides

UniffiAbstractObject.uniffiDestroy

uniffiUse()

uniffiUse<T>(block): T;

A convenience method to use this object, then destroy it after its use.

Type Parameters

T

T

Parameters

block

(obj) => T

Returns

T

Inherited from

UniffiAbstractObject.uniffiUse

instanceOf()

static instanceOf(obj_): obj_ is ModuleMetadata;

Parameters

obj_

any

Returns

obj_ is ModuleMetadata


tryFromBcs()

static tryFromBcs(bytes): ModuleMetadataLike;

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

Parameters

bytes

ArrayBuffer

Returns

ModuleMetadataLike


tryFromObject()

static tryFromObject(object): ModuleMetadataLike;

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

Parameters

object

ObjectLike

Returns

ModuleMetadataLike