Skip to main content

StructTag

Namespace: IotaSdk

Type information for a move struct

BCS

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

struct-tag = address ; address of the package
identifier ; name of the module
identifier ; name of the type
(vector type-tag) ; type parameters
public class StructTag : IStructTag, System.IEquatable`1[[IotaSdk.StructTag, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.IDisposable

Inheritance Object → StructTag
Implements IStructTag, IEquatable<StructTag>, IDisposable
Attributes NullableContextAttribute, NullableAttribute

Constructors​

StructTag(UInt64)​

public StructTag(ulong pointer)

Parameters​

pointer UInt64

StructTag(Address, Identifier, Identifier, TypeTag[])​

public StructTag(Address address, Identifier module, Identifier name, TypeTag[] typeParams = null)

Parameters​

address Address

module Identifier

name Identifier

typeParams TypeTag[]

Methods​

Destroy()​

public void Destroy()

Dispose()​

public void Dispose()

Address()​

Returns the address part of a StructTag

public Address Address()

Returns​

Address

CoinType()​

Returns the coin type part of a StructTag, panics if this is not a Coin type

public TypeTag CoinType()

Returns​

TypeTag

CoinTypeOpt()​

Returns the coin type part of a StructTag, if this is a Coin type

public TypeTag? CoinTypeOpt()

Returns​

TypeTag?

IsAlias()​

public bool IsAlias()

Returns​

Boolean

IsAliasOutput()​

public bool IsAliasOutput()

Returns​

Boolean

IsAsciiString()​

public bool IsAsciiString()

Returns​

Boolean

IsAuthenticatorFunctionRefV1Key()​

public bool IsAuthenticatorFunctionRefV1Key()

Returns​

Boolean

IsBag()​

public bool IsBag()

Returns​

Boolean

IsBalance()​

public bool IsBalance()

Returns​

Boolean

IsBasicOutput()​

public bool IsBasicOutput()

Returns​

Boolean

IsClock()​

public bool IsClock()

Returns​

Boolean

IsCoin()​

public bool IsCoin()

Returns​

Boolean

IsCoinManager()​

public bool IsCoinManager()

Returns​

Boolean

IsCoinMetadata()​

public bool IsCoinMetadata()

Returns​

Boolean

IsConfig()​

public bool IsConfig()

Returns​

Boolean

IsConfigSetting()​

public bool IsConfigSetting()

Returns​

Boolean

IsDenyCapV1()​

public bool IsDenyCapV1()

Returns​

Boolean

IsDenyListAddressKey()​

public bool IsDenyListAddressKey()

Returns​

Boolean

IsDenyListConfigKey()​

public bool IsDenyListConfigKey()

Returns​

Boolean

IsDenyListGlobalPauseKey()​

public bool IsDenyListGlobalPauseKey()

Returns​

Boolean

IsDisplayCreated()​

public bool IsDisplayCreated()

Returns​

Boolean

IsDisplayVersionUpdated()​

public bool IsDisplayVersionUpdated()

Returns​

Boolean

IsDynamicField()​

public bool IsDynamicField()

Returns​

Boolean

IsDynamicObjectFieldWrapper()​

public bool IsDynamicObjectFieldWrapper()

Returns​

Boolean

IsGas()​

public bool IsGas()

Returns​

Boolean

IsGasBalance()​

public bool IsGasBalance()

Returns​

Boolean

IsGasCoin()​

public bool IsGasCoin()

Returns​

Boolean

IsId()​

public bool IsId()

Returns​

Boolean

IsIotaSystemAdminCap()​

public bool IsIotaSystemAdminCap()

Returns​

Boolean

IsIotaSystemState()​

public bool IsIotaSystemState()

Returns​

Boolean

IsIotaTreasuryCap()​

public bool IsIotaTreasuryCap()

Returns​

Boolean

IsIrc27Metadata()​

public bool IsIrc27Metadata()

Returns​

Boolean

IsKiosk()​

public bool IsKiosk()

Returns​

Boolean

IsKioskOwnerCap()​

public bool IsKioskOwnerCap()

Returns​

Boolean

IsName()​

Checks if this is an IOTA-Names Name type. Note that this does not check the package address, so it will return true for any struct with the correct module and type name with no type params.

public bool IsName()

Returns​

Boolean

IsNft()​

public bool IsNft()

Returns​

Boolean

IsNftOutput()​

public bool IsNftOutput()

Returns​

Boolean

IsObjectBag()​

public bool IsObjectBag()

Returns​

Boolean

IsOption()​

public bool IsOption()

Returns​

Boolean

IsPackageMetadataKey()​

public bool IsPackageMetadataKey()

Returns​

Boolean

IsPublisher()​

public bool IsPublisher()

Returns​

Boolean

IsRandom()​

public bool IsRandom()

Returns​

Boolean

IsRegulatedCoinMetadata()​

public bool IsRegulatedCoinMetadata()

Returns​

Boolean

IsSameTypeAs(StructTag)​

Returns whether the type (excluding the type params) is the same as another struct tag.

public bool IsSameTypeAs(StructTag other)

Parameters​

other StructTag

Returns​

Boolean

IsStakedIota()​

public bool IsStakedIota()

Returns​

Boolean

IsString()​

public bool IsString()

Returns​

Boolean

IsSystemEpochInfoEvent()​

public bool IsSystemEpochInfoEvent()

Returns​

Boolean

IsTimeLock()​

public bool IsTimeLock()

Returns​

Boolean

IsTimelockedBalance()​

public bool IsTimelockedBalance()

Returns​

Boolean

IsTimelockedGasBalance()​

public bool IsTimelockedGasBalance()

Returns​

Boolean

IsTimelockedStakedIota()​

public bool IsTimelockedStakedIota()

Returns​

Boolean

IsTransferReceiving()​

public bool IsTransferReceiving()

Returns​

Boolean

IsTreasuryCap()​

public bool IsTreasuryCap()

Returns​

Boolean

IsTxContext()​

public bool IsTxContext()

Returns​

Boolean

IsUid()​

public bool IsUid()

Returns​

Boolean

IsUpgradeCap()​

public bool IsUpgradeCap()

Returns​

Boolean

IsUpgradeReceipt()​

public bool IsUpgradeReceipt()

Returns​

Boolean

IsUpgradeTicket()​

public bool IsUpgradeTicket()

Returns​

Boolean

IsUrl()​

public bool IsUrl()

Returns​

Boolean

Module()​

Returns the module part of a StructTag

public Identifier Module()

Returns​

Identifier

Name()​

Returns the name part of a StructTag

public Identifier Name()

Returns​

Identifier

ToCanonicalString(Boolean)​

Returns the string representation of this struct tag using the canonical display, with or without a 0x prefix.

public string ToCanonicalString(bool withPrefix)

Parameters​

withPrefix Boolean

Returns​

String

TypeArgs()​

Returns the type params part of a StructTag

public TypeTag[] TypeArgs()

Returns​

TypeTag[]

ToString()​

public override string ToString()

Returns​

String

Equals(StructTag)​

public bool Equals(StructTag? other)

Parameters​

other StructTag?

Returns​

Boolean

Equals(Object)​

public override bool Equals(object? obj)

Parameters​

obj Object?

Returns​

Boolean

GetHashCode()​

public override int GetHashCode()

Returns​

Int32

NewAlias()​

public static StructTag NewAlias()

Returns​

StructTag

NewAliasOutput(TypeTag)​

public static StructTag NewAliasOutput(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewAsciiString()​

public static StructTag NewAsciiString()

Returns​

StructTag

NewAuthenticatorFunctionRefV1Key()​

public static StructTag NewAuthenticatorFunctionRefV1Key()

Returns​

StructTag

NewBag()​

public static StructTag NewBag()

Returns​

StructTag

NewBalance(TypeTag)​

public static StructTag NewBalance(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewBasicOutput(TypeTag)​

public static StructTag NewBasicOutput(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewClock()​

public static StructTag NewClock()

Returns​

StructTag

NewCoin(TypeTag)​

public static StructTag NewCoin(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewCoinManager(StructTag)​

public static StructTag NewCoinManager(StructTag structTag)

Parameters​

structTag StructTag

Returns​

StructTag

NewCoinMetadata(StructTag)​

public static StructTag NewCoinMetadata(StructTag structTag)

Parameters​

structTag StructTag

Returns​

StructTag

NewConfig(TypeTag)​

public static StructTag NewConfig(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewConfigSetting(TypeTag)​

public static StructTag NewConfigSetting(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewDenyCapV1(TypeTag)​

public static StructTag NewDenyCapV1(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewDenyListAddressKey()​

public static StructTag NewDenyListAddressKey()

Returns​

StructTag

NewDenyListConfigKey()​

public static StructTag NewDenyListConfigKey()

Returns​

StructTag

NewDenyListGlobalPauseKey()​

public static StructTag NewDenyListGlobalPauseKey()

Returns​

StructTag

NewDisplayCreated(StructTag)​

public static StructTag NewDisplayCreated(StructTag structTag)

Parameters​

structTag StructTag

Returns​

StructTag

NewDisplayVersionUpdated(StructTag)​

public static StructTag NewDisplayVersionUpdated(StructTag structTag)

Parameters​

structTag StructTag

Returns​

StructTag

NewDynamicField(TypeTag, TypeTag)​

public static StructTag NewDynamicField(TypeTag key, TypeTag value)

Parameters​

key TypeTag

value TypeTag

Returns​

StructTag

NewDynamicObjectFieldWrapper(TypeTag)​

public static StructTag NewDynamicObjectFieldWrapper(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewGas()​

public static StructTag NewGas()

Returns​

StructTag

NewGasCoin()​

public static StructTag NewGasCoin()

Returns​

StructTag

NewId()​

public static StructTag NewId()

Returns​

StructTag

NewIotaSystemAdminCap()​

public static StructTag NewIotaSystemAdminCap()

Returns​

StructTag

NewIotaSystemState()​

public static StructTag NewIotaSystemState()

Returns​

StructTag

NewIotaTreasuryCap()​

public static StructTag NewIotaTreasuryCap()

Returns​

StructTag

NewIrc27Metadata()​

public static StructTag NewIrc27Metadata()

Returns​

StructTag

NewKiosk()​

public static StructTag NewKiosk()

Returns​

StructTag

NewKioskOwnerCap()​

public static StructTag NewKioskOwnerCap()

Returns​

StructTag

NewName(Address)​

Creates a new IOTA-Names Name struct tag with the given package address.

public static StructTag NewName(Address address)

Parameters​

address Address

Returns​

StructTag

NewNft()​

public static StructTag NewNft()

Returns​

StructTag

NewNftOutput(TypeTag)​

public static StructTag NewNftOutput(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewObjectBag()​

public static StructTag NewObjectBag()

Returns​

StructTag

NewOption(TypeTag)​

public static StructTag NewOption(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewPackageMetadataKey()​

public static StructTag NewPackageMetadataKey()

Returns​

StructTag

NewPublisher()​

public static StructTag NewPublisher()

Returns​

StructTag

NewRandom()​

public static StructTag NewRandom()

Returns​

StructTag

NewRegulatedCoinMetadata(TypeTag)​

public static StructTag NewRegulatedCoinMetadata(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewStakedIota()​

public static StructTag NewStakedIota()

Returns​

StructTag

NewString()​

public static StructTag NewString()

Returns​

StructTag

NewSystemEpochInfoEvent()​

public static StructTag NewSystemEpochInfoEvent()

Returns​

StructTag

NewTimeLock(TypeTag)​

public static StructTag NewTimeLock(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewTimelockedGasBalance()​

public static StructTag NewTimelockedGasBalance()

Returns​

StructTag

NewTimelockedStakedIota()​

public static StructTag NewTimelockedStakedIota()

Returns​

StructTag

NewTransferReceiving(TypeTag)​

public static StructTag NewTransferReceiving(TypeTag typeTag)

Parameters​

typeTag TypeTag

Returns​

StructTag

NewTreasuryCap(StructTag)​

public static StructTag NewTreasuryCap(StructTag structTag)

Parameters​

structTag StructTag

Returns​

StructTag

NewTxContext()​

public static StructTag NewTxContext()

Returns​

StructTag

NewUid()​

public static StructTag NewUid()

Returns​

StructTag

NewUpgradeCap()​

public static StructTag NewUpgradeCap()

Returns​

StructTag

NewUpgradeReceipt()​

public static StructTag NewUpgradeReceipt()

Returns​

StructTag

NewUpgradeTicket()​

public static StructTag NewUpgradeTicket()

Returns​

StructTag

NewUrl()​

public static StructTag NewUrl()

Returns​

StructTag