Skip to main content

Class: Input

An input to a user transaction

BCS

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

input = call-arg

call-arg   =  %d00 bytes        ; Pure
=/ %d01 object-arg   ; Object

object-arg =  %d00 object-reference     ; ImmutableOrOwned
=/ %d01 object-id u64 bool   ; Shared
=/ %d02 object-reference     ; Receiving

Extends​

  • UniffiAbstractObject

Implements​

Properties​

[destructorGuardSymbol]​

readonly [destructorGuardSymbol]: UniffiGcObject;

[pointerLiteralSymbol]​

readonly [pointerLiteralSymbol]: bigint;

[uniffiTypeNameSymbol]​

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

Methods​

equals()​

equals(other): boolean;

Parameters​

other​

Input

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

Parameters​

obj_​

any

Returns​

obj_ is Input

newImmutableOrOwned()​

static newImmutableOrOwned(objectRef): InputLike;

A move object that is either immutable or address owned

Parameters​

objectRef​

ObjectReference

Returns​

InputLike

newPure()​

static newPure(value): InputLike;

For normal operations this is required to be a move primitive type and not contain structs or objects.

Parameters​

value​

ArrayBuffer

Returns​

InputLike

newReceiving()​

static newReceiving(objectRef): InputLike;

Parameters​

objectRef​

ObjectReference

Returns​

InputLike

newShared()​

static newShared(
   objectId, 
   initialSharedVersion, 
   mutable
): InputLike;

A move object whose owner is "Shared"

Parameters​

objectId​

ObjectIdLike

initialSharedVersion​

VersionLike

mutable​

boolean

Returns​

InputLike