Struct Object

pub struct Object {

    pub bcs: Option<Bcs>,
    pub object_id: Option<String>,
    pub version: Option<u64>,
    pub digest: Option<String>,
    pub owner: Option<Owner>,
    pub object_type: Option<String>,
    pub has_public_transfer: Option<bool>,
    pub contents: Option<Bcs>,
    pub modules: Vec<MoveModule>,
    pub type_origin_table: Vec<TypeOrigin>,
    pub linkage_table: Vec<UpgradeInfo>,
    pub previous_transaction: Option<String>,
    pub storage_rebate: Option<u64>,
}

An object on the Sui blockchain.

Fields

bcs: Option<Bcs>

This Object serialized as BCS.

object_id: Option<String>

ObjectId for this object.

version: Option<u64>

Version of the object.

digest: Option<String>

The digest of this Object.

owner: Option<Owner>

Owner of the object.

object_type: Option<String>

The type of this object.

This will be ‘package’ for packages and a StructTag for move structs.

has_public_transfer: Option<bool>

DEPRECATED this field is no longer used to determine whether a tx can transfer this object. Instead, it is always calculated from the objects type when loaded in execution.

Only set for Move structs

contents: Option<Bcs>

BCS bytes of a Move struct value.

Only set for Move structs

modules: Vec<MoveModule>

Set of modules defined by this package.

Only set for Packages

type_origin_table: Vec<TypeOrigin>

Maps struct/module to a package version where it was first defined, stored as a vector for simple serialization and deserialization.

Only set for Packages

linkage_table: Vec<UpgradeInfo>

For each dependency, maps original package ID to the info about the (upgraded) dependency version that this package is using.

Only set for Packages

previous_transaction: Option<String>

The digest of the transaction that created or last mutated this object

storage_rebate: Option<u64>

The amount of SUI to rebate if this object gets deleted. This number is re-calculated each time the object is mutated based on the present storage gas price.

Implementations

impl Object

pub const BCS_FIELD: &'static MessageField

pub const OBJECT_ID_FIELD: &'static MessageField

pub const VERSION_FIELD: &'static MessageField

pub const DIGEST_FIELD: &'static MessageField

pub const OWNER_FIELD: &'static MessageField

pub const OBJECT_TYPE_FIELD: &'static MessageField

pub const HAS_PUBLIC_TRANSFER_FIELD: &'static MessageField

pub const CONTENTS_FIELD: &'static MessageField

pub const MODULES_FIELD: &'static MessageField

pub const TYPE_ORIGIN_TABLE_FIELD: &'static MessageField

pub const LINKAGE_TABLE_FIELD: &'static MessageField

pub const PREVIOUS_TRANSACTION_FIELD: &'static MessageField

pub const STORAGE_REBATE_FIELD: &'static MessageField

impl Object

pub fn object_id(&self) -> &str

Returns the value of object_id, or the default value if object_id is unset.

pub fn version(&self) -> u64

Returns the value of version, or the default value if version is unset.

pub fn digest(&self) -> &str

Returns the value of digest, or the default value if digest is unset.

pub fn object_type(&self) -> &str

Returns the value of object_type, or the default value if object_type is unset.

pub fn has_public_transfer(&self) -> bool

Returns the value of has_public_transfer, or the default value if has_public_transfer is unset.

pub fn previous_transaction(&self) -> &str

Returns the value of previous_transaction, or the default value if previous_transaction is unset.

pub fn storage_rebate(&self) -> u64

Returns the value of storage_rebate, or the default value if storage_rebate is unset.

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 Default for Object

fn default() -> Self

Returns the “default value” for a type.

impl From<GenesisObject> for Object

fn from(value: GenesisObject) -> Self

Converts to this type from the input type.

impl From<Object> for Object

fn from(value: Object) -> Self

Converts to this type from the input type.

impl Message for Object

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl MessageFields for Object

const FIELDS: &'static [&'static MessageField]

impl MessageMerge<&MovePackage> for Object

fn merge(&mut self, source: &MovePackage, mask: &FieldMaskTree)

impl MessageMerge<&MoveStruct> for Object

fn merge(&mut self, source: &MoveStruct, mask: &FieldMaskTree)

impl MessageMerge<&Object> for Object

fn merge(&mut self, source: &Object, mask: &FieldMaskTree)

impl MessageMerge<Object> for Object

fn merge(&mut self, source: Object, mask: &FieldMaskTree)

impl PartialEq for Object

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

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<&Object> for Object

type Error = TryFromProtoError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl StructuralPartialEq for Object