Skip to main content

Class: SplitCoins

Command to split a single coin object into multiple coins

BCS

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

split-coins = argument (vector argument)

Extends​

  • UniffiAbstractObject

Implements​

Constructors​

Constructor​

new SplitCoins(coin, amounts): SplitCoins;

Parameters​

coin​

ArgumentLike

amounts​

ArgumentLike[]

Returns​

SplitCoins

Overrides​

UniffiAbstractObject.constructor

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

amounts()​

amounts(): ArgumentLike[];

The amounts to split off

Returns​

ArgumentLike[]

Implementation of​

SplitCoinsLike.amounts

coin()​

coin(): ArgumentLike;

The coin to split

Returns​

ArgumentLike

Implementation of​

SplitCoinsLike.coin

equals()​

equals(other): boolean;

Parameters​

other​

SplitCoins

Returns​

boolean

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

Parameters​

obj_​

any

Returns​

obj_ is SplitCoins