Skip to main content

Class: TransferObjects

Command to transfer ownership of a set of objects to an address

BCS

The BCS serialized form for this type is defined by the following ABNF:

transfer-objects = (vector argument) argument

Extends​

  • UniffiAbstractObject

Implements​

Constructors​

Constructor​

new TransferObjects(objects, address): TransferObjects;

Parameters​

objects​

ArgumentLike[]

address​

ArgumentLike

Returns​

TransferObjects

Overrides​

UniffiAbstractObject.constructor

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

address()​

address(): ArgumentLike;

The address to transfer ownership to

Returns​

ArgumentLike

Implementation of​

TransferObjectsLike.address

equals()​

equals(other): boolean;

Parameters​

other​

TransferObjects

Returns​

boolean

objects()​

objects(): ArgumentLike[];

Set of objects to transfer

Returns​

ArgumentLike[]

Implementation of​

TransferObjectsLike.objects

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 TransferObjects;

Parameters​

obj_​

any

Returns​

obj_ is TransferObjects