Struct sui_types::object::MoveObject

pub struct MoveObject { /* private fields */ }

Implementations

impl MoveObject

pub unsafe fn new_from_execution( type_: MoveObjectType, has_public_transfer: bool, version: SequenceNumber, contents: Vec<u8>, protocol_config: &ProtocolConfig ) -> Result<Self, ExecutionError>

Creates a new Move object of type type_ with BCS encoded bytes in contents has_public_transfer is determined by the abilities of the type_, but resolving the abilities requires the compiled modules of the type_: StructTag. In other words, has_public_transfer will be the same for all objects of the same type_.

Safety

This function should ONLY be called if has_public_transfer has been determined by the type_. Yes, this is a bit of an abuse of the unsafe marker, but bad things will happen if this is inconsistent

pub unsafe fn new_from_execution_with_limit( type_: MoveObjectType, has_public_transfer: bool, version: SequenceNumber, contents: Vec<u8>, max_move_object_size: u64 ) -> Result<Self, ExecutionError>

Safety

This function should ONLY be called if has_public_transfer has been determined by the type_

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

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

pub fn type_(&self) -> &MoveObjectType

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

pub fn has_public_transfer(&self) -> bool

pub fn id(&self) -> ObjectID

pub fn id_opt(contents: &[u8]) -> Result<ObjectID, ObjectIDParseError>

pub fn get_coin_value_unsafe(&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.

pub fn set_coin_value_unsafe(&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.

pub fn set_clock_timestamp_ms_unsafe(&mut self, timestamp_ms: u64)

Update the timestamp_ms: u64 field of the Clock type.

Panics if the object isn’t a Clock.

pub fn is_coin(&self) -> bool

pub fn is_staked_sui(&self) -> bool

pub fn is_clock(&self) -> bool

pub fn version(&self) -> SequenceNumber

pub 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

pub 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).

pub fn decrement_version_to(&mut self, prev: SequenceNumber)

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

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

pub fn into_type(self) -> MoveObjectType

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

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

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

pub fn get_layout_from_struct_tag( struct_tag: StructTag, resolver: &impl GetModule ) -> Result<MoveStructLayout, SuiError>

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

Convert self to the JSON representation dictated by layout.

pub fn to_move_struct_with_resolver( &self, resolver: &impl GetModule ) -> Result<MoveStruct, SuiError>

Convert self to the JSON representation dictated by layout.

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

pub 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.

pub fn get_total_sui( &self, layout_resolver: &mut dyn LayoutResolver ) -> Result<u64, SuiError>

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

impl MoveObject

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

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

Trait Implementations

impl Clone for MoveObject

fn clone(&self) -> MoveObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MoveObject

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MoveObject

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for MoveObject

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for MoveObject

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&MoveObject> 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 MoveObject

impl StructuralPartialEq for MoveObject