Skip to main content

Class: Argument

An argument to a programmable transaction command

BCS

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

argument    =  argument-gas
=/ argument-input
=/ argument-result
=/ argument-nested-result

argument-gas            = %d00
argument-input          = %d01 u16
argument-result         = %d02 u16
argument-nested-result  = %d03 u16 u16

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

equals()​

equals(other): boolean;

Parameters​

other​

Argument

Returns​

boolean

getNestedResult()​

getNestedResult(ix): ArgumentLike | undefined;

Get the nested result for this result at the given index. Returns None if this is not a Result.

Parameters​

ix​

number

Returns​

ArgumentLike | undefined

Implementation of​

ArgumentLike.getNestedResult

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

Parameters​

obj_​

any

Returns​

obj_ is Argument

newGas()​

static newGas(): ArgumentLike;

The gas coin. The gas coin can only be used by-ref, except for with TransferObjects, which can use it by-value.

Returns​

ArgumentLike

newInput()​

static newInput(input): ArgumentLike;

One of the input objects or primitive values (from ProgrammableTransaction inputs)

Parameters​

input​

number

Returns​

ArgumentLike

newNestedResult()​

static newNestedResult(commandIndex, subresultIndex): ArgumentLike;

Like a Result but it accesses a nested result. Currently, the only usage of this is to access a value from a Move call with multiple return values.

Parameters​

commandIndex​

number

subresultIndex​

number

Returns​

ArgumentLike

newResult()​

static newResult(result): ArgumentLike;

The result of another command (from ProgrammableTransaction commands)

Parameters​

result​

number

Returns​

ArgumentLike