Struct MoveObject 

pub struct MoveObject { /* private fields */ }

A move struct

BCS

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

move-struct = compressed-struct-tag u64 bytes

compressed-struct-tag = other-struct-type / gas-coin-type / staked-iota-type / coin-type
other-struct-type     = %d00 struct-tag
gas-coin-type         = %d01
staked-iota-type      = %d02
coin-type             = %d03 type-tag

; The first 32 bytes of the `bytes` contents are the object's object-id.

Implementations

impl MoveStruct

pub fn new( object_type: MoveObjectType, version: Version, contents: Vec<u8>, ) -> Result<MoveStruct, MoveStructContentsError>

Creates a new MoveStruct.

Errors

Returns an error if contents is shorter than ObjectId::LENGTH bytes, since every Move object must contain its ObjectId as the leading bytes.

pub fn object_type(&self) -> &MoveObjectType

Returns the type of this Move object.

pub fn struct_tag(&self) -> &StructTag

Returns the object type as a StructTag reference.

pub fn is_struct_tag(&self, s: &StructTag) -> bool

Returns true if the object’s type matches the given StructTag.

pub fn id(&self) -> ObjectId

Returns the object’s ID, extracted from the BCS-encoded contents.

This is always valid because the constructor guarantees that contents is at least ObjectId::LENGTH bytes long.

pub fn version(&self) -> Version

Returns the version (lamport timestamp) of this object.

pub fn set_version(&mut self, version: Version)

Sets the version (lamport timestamp) of this object.

pub fn set_object_type(&mut self, object_type: MoveObjectType)

Sets the type of this object.

The caller must ensure the existing contents are a valid BCS encoding of the new object_type; this is not verified.

pub fn contents(&self) -> &[u8]

Returns the raw BCS-encoded contents of this object.

pub fn set_contents( &mut self, contents: Vec<u8>, ) -> Result<(), MoveStructContentsError>

Replaces the BCS-encoded contents of this object.

The caller must ensure the new contents are a valid BCS encoding of the object’s object_type; this is not verified.

Errors

Returns an error if contents is shorter than ObjectId::LENGTH bytes.

pub fn into_contents(self) -> Vec<u8>

Consumes the object and returns the raw BCS-encoded contents.

pub fn type_tag(&self) -> TypeTag

Returns the object type as a TypeTag.

pub fn into_parts(self) -> (MoveObjectType, Version, Vec<u8>)

Consumes the object and returns its type, version, and raw contents.

pub fn to_rust<'de, T>(&'de self) -> Option<T>

where T: Deserialize<'de>,

Deserializes the BCS-encoded contents into a Rust type.

Trait Implementations

impl Arbitrary for MoveStruct

type Parameters = ()

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

type Strategy = BoxedStrategy<MoveStruct>

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

fn arbitrary_with( args_shared: <MoveStruct as Arbitrary>::Parameters, ) -> <MoveStruct as Arbitrary>::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 MoveStruct

fn clone(&self) -> MoveStruct

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MoveStruct

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MoveStruct

fn deserialize<D>( deserializer: D, ) -> Result<MoveStruct, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MoveStruct

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

where __H: Hasher,

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 MoveObjectExt for MoveObject

fn new_from_execution( tag: StructTag, version: SequenceNumber, contents: Vec<u8>, protocol_config: &ProtocolConfig, ) -> Result<Self, ExecutionError>

Creates a new Move object of type tag with BCS encoded bytes in contents.

fn new_from_execution_with_limit( tag: StructTag, version: SequenceNumber, contents: Vec<u8>, max_move_object_size: u64, ) -> Result<Self, ExecutionError>

Creates a new Move object of type tag with BCS encoded bytes in contents. It allows to set a max_move_object_size for that.

fn get_coin_value_unchecked(&self) -> u64

Return the value: u64 field of a Coin<T> type. Useful for reading the coin without deserializing the object into a Move value. It is the caller’s responsibility to check that self is a coin. This function may panic or do something unexpected otherwise.

fn set_coin_value_unchecked(&mut self, value: u64)

Update the value: u64 field of a Coin<T> type. Useful for updating the coin without deserializing the object into a Move value. It is the caller’s responsibility to check that self is a coin. This function may panic or do something unexpected otherwise.

fn set_clock_timestamp_ms_unchecked(&mut self, timestamp_ms: u64)

Update the timestamp_ms: u64 field of the Clock type.

Panics if the object isn’t a Clock.

fn update_contents( &mut self, new_contents: Vec<u8>, protocol_config: &ProtocolConfig, ) -> Result<(), ExecutionError>

Update the contents of this object but does not increment its version

fn increment_version_to(&mut self, next: SequenceNumber)

Sets the version of this object to a new value which is assumed to be higher (and checked to be higher in debug).

fn decrement_version_to(&mut self, prev: SequenceNumber)

Sets the version to a lower value (checked in debug).

fn get_layout( &self, resolver: &impl GetModule, ) -> Result<MoveStructLayout, IotaError>

Get a MoveStructLayout for self. The resolver value must contain the module that declares self.object_type and the (transitive) dependencies of self.object_type in order for this to succeed. Failure will result in an ObjectSerializationError

fn to_move_struct( &self, layout: &MoveStructLayout, ) -> Result<MoveStruct, IotaError>

Convert self to the JSON representation dictated by layout.

fn object_size_for_gas_metering(&self) -> usize

Approximate size of the object in bytes. This is used for gas metering. For the type tag field, we serialize it on the spot to get the accurate size. This should not be very expensive since the type tag is usually simple, and we only do this once per object being mutated.

fn get_total_iota( &self, layout_resolver: &mut dyn LayoutResolver, ) -> Result<u64, IotaError>

Get the total amount of IOTA embedded in self. Intended for testing purposes

fn get_coin_balances( &self, layout_resolver: &mut dyn LayoutResolver, ) -> Result<BTreeMap<TypeTag, u64>, IotaError>

Get the total balances for all Coin<T> embedded in self.

fn new_gas_coin(version: SequenceNumber, id: ObjectID, value: u64) -> Self

fn new_coin( coin_type: TypeTag, version: SequenceNumber, id: ObjectID, value: u64, ) -> Self

fn update_contents_with_limit( &mut self, new_contents: Vec<u8>, max_move_object_size: u64, ) -> Result<(), ExecutionError>

fn get_struct_layout_from_struct_tag( struct_tag: StructTag, resolver: &impl GetModule, ) -> Result<MoveStructLayout, IotaError>

impl PartialEq for MoveStruct

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MoveStruct

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MoveStruct> for GasCoin

type Error = ExecutionError

The type returned in the event of a conversion error.

fn try_from(value: &MoveObject) -> Result<GasCoin, ExecutionError>

Performs the conversion.

impl Eq for MoveStruct

impl StructuralPartialEq for MoveStruct