Struct ObjectId

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

An ObjectId is a 32-byte identifier used to uniquely identify an object on the Sui blockchain.

Relationship to Address

Addresses and ObjectIds share the same 32-byte addressable space but are derived leveraging different domain-separator values to ensure, cryptographically, that there won’t be any overlap, e.g. there can’t be a valid Object whose ObjectId is equal to that of the Address of a user account.

BCS

An ObjectId’s BCS serialized form is defined by the following:

object-id = 32*OCTET

Implementations

impl ObjectId

pub const LENGTH: usize = 32usize

pub const ZERO: Self = _

pub const fn new(bytes: [u8; 32]) -> Self

Generates a new ObjectId from the provided byte array.

pub const fn into_inner(self) -> [u8; 32]

Returns the underlying byte array of an ObjectId.

pub const fn inner(&self) -> &[u8; 32]

Returns a reference to the underlying byte array of an ObjectId.

pub const fn as_bytes(&self) -> &[u8]

Returns a slice of bytes of an ObjectId.

pub const fn as_address(&self) -> &Address

Returns the underlying Address of an ObjectId.

impl ObjectId

pub fn derive_id(digest: TransactionDigest, count: u64) -> Self

Available on crate feature hash only.

Create an ObjectId from TransactionDigest and count.

count is the number of objects that have been created during a transactions.

pub fn derive_dynamic_child_id( &self, key_type_tag: &TypeTag, key_bytes: &[u8], ) -> Self

Available on crate features hash and serde only.

Derive an ObjectId for a Dynamic Child Object.

hash(parent || len(key) || key || key_type_tag)

Trait Implementations

impl Arbitrary for ObjectId

type Parameters = ()

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

type Strategy = BoxedStrategy<ObjectId>

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

fn arbitrary_with(args: <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 AsRef<[u8]> for ObjectId

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for ObjectId

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ObjectId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl From<[u8; 32]> for ObjectId

fn from(object_id: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<Address> for ObjectId

fn from(value: Address) -> Self

Converts to this type from the input type.

impl From<ObjectId> for [u8; 32]

fn from(object_id: ObjectId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for Address

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for Vec<u8>

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl FromStr for ObjectId

type Err = AddressParseError

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 ObjectId

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 ObjectId

fn cmp(&self, other: &ObjectId) -> 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.

impl PartialEq for ObjectId

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ObjectId

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId