Struct MoveObjectType 

pub struct MoveObjectType(/* private fields */);

A StructTag with optimized BCS serialization for object types.

GasCoin, StakedIota, and Coin variants use compact enum encoding instead of the full StructTag representation. The Other variant carries the full StructTag inline.

BCS

compressed-struct-tag = other-struct-type / gas-coin-type / staked-iota-type / coin-type
other-struct-type     = %x00 struct-tag
gas-coin-type         = %x01
staked-iota-type      = %x02
coin-type             = %x03 type-tag

Implementations

impl MoveObjectType

pub fn new(tag: StructTag) -> Self

pub fn into_inner(self) -> StructTag

Methods from Deref<Target = StructTag>

pub fn is_same_type_as(&self, other: &StructTag) -> bool

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

pub fn is_gas(&self) -> bool

Checks if this is a framework IOTA gas type (0x2::iota::IOTA)

pub fn is_gas_coin(&self) -> bool

Checks if this is a framework gas coin type (0x2::coin::Coin<0x2::iota::IOTA>)

pub fn is_id(&self) -> bool

Checks if this is a framework object ID type (0x2::object::ID)

pub fn is_uid(&self) -> bool

Checks if this is a framework object UID type (0x2::object::UID)

pub fn is_name(&self) -> bool

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.

pub fn is_dynamic_field(&self) -> bool

Checks if this is a Dynamic Field type (0x2::dynamic_field::Field<KeyType, ValueType>)

pub fn opt_coin_type(&self) -> Option<&TypeTag>

Returns the coin type if this is a Coin type, None otherwise

pub fn coin_type(&self) -> &TypeTag

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

pub fn address(&self) -> Address

Returns the address part of a StructTag

pub fn module(&self) -> &Identifier

Returns the module part of a StructTag

pub fn name(&self) -> &Identifier

Returns the name part of a StructTag

pub fn type_params(&self) -> &[TypeTag]

Returns the type params part of a StructTag

pub fn is_timelocked_balance(&self) -> bool

Checks if this is a timelocked coin balance TimeLock<Balance<T>>

pub fn is_gas_balance(&self) -> bool

Checks if this is an IOTA balance type (0x2::balance::Balance<0x2::iota::IOTA>)

pub fn is_timelocked_gas_balance(&self) -> bool

Checks if this is a timelocked IOTA balance type (0x2::timelock::TimeLock<0x2::balance::Balance<0x2::iota::IOTA>>)

pub fn to_canonical_string(&self, with_prefix: bool) -> String

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

pub fn is_clock(&self) -> bool

pub fn is_iota_treasury_cap(&self) -> bool

pub fn is_kiosk(&self) -> bool

pub fn is_kiosk_owner_cap(&self) -> bool

pub fn is_publisher(&self) -> bool

pub fn is_upgrade_cap(&self) -> bool

pub fn is_upgrade_ticket(&self) -> bool

pub fn is_upgrade_receipt(&self) -> bool

pub fn is_random(&self) -> bool

pub fn is_iota_system_admin_cap(&self) -> bool

pub fn is_url(&self) -> bool

pub fn is_bag(&self) -> bool

pub fn is_object_bag(&self) -> bool

pub fn is_tx_context(&self) -> bool

pub fn is_deny_list(&self) -> bool

pub fn is_transaction_deny_rules(&self) -> bool

pub fn is_package_metadata_v1(&self) -> bool

pub fn is_package_metadata_key(&self) -> bool

pub fn is_module_metadata(&self) -> bool

pub fn is_authenticator_function_ref_v1_key(&self) -> bool

pub fn is_deny_list_config_key(&self) -> bool

pub fn is_deny_list_address_key(&self) -> bool

pub fn is_deny_list_global_pause_key(&self) -> bool

pub fn is_iota_system_state(&self) -> bool

pub fn is_staked_iota(&self) -> bool

pub fn is_timelocked_staked_iota(&self) -> bool

pub fn is_system_epoch_info_event(&self) -> bool

pub fn is_unverified_validator_operation_cap(&self) -> bool

pub fn is_string(&self) -> bool

pub fn is_ascii_string(&self) -> bool

pub fn is_coin_metadata(&self) -> bool

pub fn is_treasury_cap(&self) -> bool

pub fn is_coin_manager(&self) -> bool

pub fn is_display_created(&self) -> bool

pub fn is_display_version_updated(&self) -> bool

pub fn is_coin(&self) -> bool

pub fn is_regulated_coin_metadata(&self) -> bool

pub fn is_deny_cap_v1(&self) -> bool

pub fn is_balance(&self) -> bool

pub fn is_time_lock(&self) -> bool

pub fn is_config(&self) -> bool

pub fn is_display(&self) -> bool

pub fn is_coin_manager_treasury_cap(&self) -> bool

pub fn is_coin_manager_metadata_cap(&self) -> bool

pub fn is_token(&self) -> bool

pub fn is_token_policy_cap(&self) -> bool

pub fn is_token_policy(&self) -> bool

pub fn is_transfer_policy(&self) -> bool

pub fn is_transfer_policy_cap(&self) -> bool

pub fn is_labeler_cap(&self) -> bool

pub fn is_purchase_cap(&self) -> bool

pub fn is_config_setting(&self) -> bool

pub fn is_dynamic_object_field_wrapper(&self) -> bool

pub fn is_transfer_receiving(&self) -> bool

pub fn is_option(&self) -> bool

pub fn is_alias(&self) -> bool

pub fn is_nft(&self) -> bool

pub fn is_irc27_metadata(&self) -> bool

pub fn is_basic_output(&self) -> bool

pub fn is_nft_output(&self) -> bool

pub fn is_alias_output(&self) -> bool

Trait Implementations

impl Arbitrary for MoveObjectType

Available on crate feature proptest only.

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = BoxedStrategy<MoveObjectType>

The type of Strategy used to generate values of type Self.

fn arbitrary_with( args_shared: <Self as Arbitrary>::Parameters, ) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for MoveObjectType

fn clone(&self) -> MoveObjectType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MoveObjectType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Deref for MoveObjectType

type Target = StructTag

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for MoveObjectType

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for MoveObjectType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for MoveObjectType

impl From<MoveObjectType> for StructTag

fn from(obj_type: MoveObjectType) -> Self

Converts to this type from the input type.

impl From<StructTag> for MoveObjectType

fn from(tag: StructTag) -> Self

Converts to this type from the input type.

impl FromStr for MoveObjectType

type Err = TypeParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for MoveObjectType

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for MoveObjectType

fn cmp(&self, other: &MoveObjectType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for MoveObjectType

fn eq(&self, other: &MoveObjectType) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<StructTag> for MoveObjectType

fn eq(&self, other: &StructTag) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialOrd for MoveObjectType

fn partial_cmp(&self, other: &MoveObjectType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for MoveObjectType

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MoveObjectType