Struct sui_types::object::Object

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

Implementations

impl Object

pub fn into_inner(self) -> ObjectInner

pub fn as_inner(&self) -> &ObjectInner

pub fn new_from_genesis( data: Data, owner: Owner, previous_transaction: TransactionDigest ) -> Self

pub fn new_move( o: MoveObject, owner: Owner, previous_transaction: TransactionDigest ) -> Self

Create a new Move object

pub fn new_package_from_data( data: Data, previous_transaction: TransactionDigest ) -> Self

pub fn new_from_package( package: MovePackage, previous_transaction: TransactionDigest ) -> Self

pub fn new_package<'p>( modules: &[CompiledModule], previous_transaction: TransactionDigest, max_move_package_size: u64, dependencies: impl IntoIterator<Item = &'p MovePackage> ) -> Result<Self, ExecutionError>

pub fn new_upgraded_package<'p>( previous_package: &MovePackage, new_package_id: ObjectID, modules: &[CompiledModule], previous_transaction: TransactionDigest, protocol_config: &ProtocolConfig, dependencies: impl IntoIterator<Item = &'p MovePackage> ) -> Result<Self, ExecutionError>

pub fn new_package_for_testing( modules: &[CompiledModule], previous_transaction: TransactionDigest, dependencies: impl IntoIterator<Item = MovePackage> ) -> Result<Self, ExecutionError>

pub fn new_system_package( modules: &[CompiledModule], version: SequenceNumber, dependencies: Vec<ObjectID>, previous_transaction: TransactionDigest ) -> Self

Create a system package which is not subject to size limits. Panics if the object ID is not a known system package.

impl Object

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

Get the total amount of SUI embedded in self, including both Move objects and the storage rebate

pub fn immutable_with_id_for_testing(id: ObjectID) -> Self

pub fn immutable_for_testing() -> Self

pub fn shared_for_testing() -> Object

Make a test shared object. Note that this function returns the same object called from the same thread.

pub fn with_id_shared_for_testing(id: ObjectID) -> Object

Make a new test sahred object.

pub fn with_id_owner_gas_for_testing( id: ObjectID, owner: SuiAddress, gas: u64 ) -> Self

pub fn treasury_cap_for_testing( struct_tag: StructTag, treasury_cap: TreasuryCap ) -> Self

pub fn coin_metadata_for_testing( struct_tag: StructTag, metadata: CoinMetadata ) -> Self

pub fn with_object_owner_for_testing(id: ObjectID, owner: ObjectID) -> Self

pub fn with_id_owner_for_testing(id: ObjectID, owner: SuiAddress) -> Self

pub fn with_id_owner_version_for_testing( id: ObjectID, version: SequenceNumber, owner: SuiAddress ) -> Self

pub fn with_owner_for_testing(owner: SuiAddress) -> Self

pub fn new_gas_with_balance_and_owner_for_testing( value: u64, owner: SuiAddress ) -> Self

Generate a new gas coin worth value with a random object ID and owner For testing purposes only

pub fn new_gas_for_testing() -> Self

Generate a new gas coin object with default balance and random owner.

Methods from Deref<Target = ObjectInner>

pub fn is_system_package(&self) -> bool

Returns true if the object is a system package.

pub fn is_immutable(&self) -> bool

pub fn is_address_owned(&self) -> bool

pub fn is_child_object(&self) -> bool

pub fn is_shared(&self) -> bool

pub fn get_single_owner(&self) -> Option<SuiAddress>

pub fn get_owner_and_id(&self) -> Option<(Owner, ObjectID)>

pub fn is_package(&self) -> bool

Return true if this object is a Move package, false if it is a Move value

pub fn compute_object_reference(&self) -> ObjectRef

pub fn digest(&self) -> ObjectDigest

pub fn id(&self) -> ObjectID

pub fn version(&self) -> SequenceNumber

pub fn type_(&self) -> Option<&MoveObjectType>

pub fn struct_tag(&self) -> Option<StructTag>

pub fn is_coin(&self) -> bool

pub fn is_gas_coin(&self) -> bool

pub fn as_coin_maybe(&self) -> Option<Coin>

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

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 object_size_for_gas_metering(&self) -> usize

Approximate size of the object in bytes. This is used for gas metering. This will be slgihtly different from the serialized size, but we also don’t want to serialize the object just to get the size. This approximation should be good enough for gas metering.

pub fn transfer(&mut self, new_owner: SuiAddress)

Change the owner of self to new_owner.

pub fn get_layout( &self, resolver: &impl GetModule ) -> Result<Option<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_move_template_type(&self) -> SuiResult<TypeTag>

Treat the object type as a Move struct with one type parameter, like this: S<T>. Returns the inner parameter type T.

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

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Deref for Object

type Target = ObjectInner

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for Object

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Object

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Object> for InputKey

fn from(obj: &Object) -> Self

Converts to this type from the input type.

impl From<&Object> for ObjectType

fn from(o: &Object) -> Self

Converts to this type from the input type.

impl From<Object> for ObjectOrTombstone

fn from(object: Object) -> Self

Converts to this type from the input type.

impl From<Object> for ObjectReadResultKind

fn from(object: Object) -> Self

Converts to this type from the input type.

impl From<Object> for ReceivingObjectReadResultKind

fn from(object: Object) -> Self

Converts to this type from the input type.

impl From<ObjectInner> for Object

fn from(inner: ObjectInner) -> Self

Converts to this type from the input type.

impl From<PackageObject> for Object

fn from(package_object_arc: PackageObject) -> Self

Converts to this type from the input type.

impl Hash for Object

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 Object

fn eq(&self, other: &Object) -> 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 Object

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Object> for CoinMetadata

type Error = SuiError

The type returned in the event of a conversion error.

fn try_from(object: &Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Object> for GasCoin

type Error = ExecutionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Object> for StakedSui

type Error = SuiError

The type returned in the event of a conversion error.

fn try_from(object: &Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object> for CoinMetadata

type Error = SuiError

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Object> for TreasuryCap

type Error = SuiError

The type returned in the event of a conversion error.

fn try_from(object: Object) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Object

impl StructuralPartialEq for Object