Enum Owner

pub enum Owner {
    AddressOwner(Address),
    ObjectOwner(ObjectId),
    Shared {
        initial_shared_version: Version,
    },
    Immutable,
    ConsensusV2 {
        start_version: Version,
        authenticator: Box<Authenticator>,
    },
}

The entity that owns an object.

Variants

AddressOwner(Address)

Object is exclusively owned by a single address, and is mutable.

ObjectOwner(ObjectId)

Object is exclusively owned by a single object, and is mutable. The object ID is converted to Address as SuiAddress is universal.

Shared

Object is shared, can be used by any address, and is mutable.

Fields

initial_shared_version: Version

The version at which the object became shared

Immutable

Object is immutable, and hence ownership doesn’t matter.

ConsensusV2

Object is sequenced via consensus. Ownership is managed by the configured authenticator.

Note: wondering what happened to V1? Shared above was the V1 of consensus objects.

Fields

start_version: Version

The version at which the object most recently became a consensus object. This serves the same function as initial_shared_version, except it may change if the object’s Owner type changes.

authenticator: Box<Authenticator>

The authentication mode of the object

Implementations

impl Owner

pub const fn get_address_owner_address(&self) -> Option<Address>

Only return address of AddressOwner, otherwise return error.

ObjectOwner’s address is converted from object id, thus we will skip it.

pub const fn get_owner_address(&self) -> Option<Address>

This function will return address of both AddressOwner and ObjectOwner,

Address of ObjectOwner is converted from object id, even though the type is Address.

pub const fn is_immutable(&self) -> bool

pub const fn is_address_owned(&self) -> bool

pub const fn is_child_object(&self) -> bool

pub const fn is_shared(&self) -> bool

Trait Implementations

impl Clone for Owner

fn clone(&self) -> Owner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Owner

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Owner

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Owner

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

Formats the value using the given formatter.

impl From<Owner> for Owner

fn from(value: Owner) -> Self

Converts to this type from the input type.

impl Hash for Owner

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 Owner

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

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Owner

impl StructuralPartialEq for Owner