Enum Owner 

#[non_exhaustive]
pub enum Owner {
    Address(Address),
    Object(ObjectId),
    Shared(Version),
    Immutable,
}

Enum of different types of ownership for an object.

BCS

The BCS serialized form for this type is defined by the following ABNF:

owner = owner-address / owner-object / owner-shared / owner-immutable

owner-address   = %d00 address
owner-object    = %d01 object-id
owner-shared    = %d02 u64
owner-immutable = %d03

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Address(Address)

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

Object(ObjectId)

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

Shared(Version)

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

Tuple Fields

0: Version

The version at which the object became shared

Immutable

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

Implementations

impl Owner

pub fn is_immutable(&self) -> bool

Checks if this is a immutable variant.

pub fn is_address(&self) -> bool

Checks if this is a address variant.

pub fn as_address(&self) -> &Address

Converts this into a address if it is a address variant, or panics otherwise.

pub fn as_mut_address(&mut self) -> &mut Address

Converts this into a mut address if it is a address variant, or panics otherwise.

pub fn as_opt_address(&self) -> Option<&Address>

Converts this into a address if it is a address variant, or returns None otherwise.

pub fn as_opt_mut_address(&mut self) -> Option<&mut Address>

Converts this into a mut address if it is a address variant, or returns None otherwise.

pub fn into_opt_address(self) -> Option<Address>

Converts this into a address if it is a address variant, or returns None otherwise.

pub fn into_address(self) -> Address

Converts this into a address if it is a address variant, or panics otherwise.

pub fn is_object(&self) -> bool

Checks if this is a object variant.

pub fn as_object(&self) -> &ObjectId

Converts this into a object if it is a object variant, or panics otherwise.

pub fn as_mut_object(&mut self) -> &mut ObjectId

Converts this into a mut object if it is a object variant, or panics otherwise.

pub fn as_opt_object(&self) -> Option<&ObjectId>

Converts this into a object if it is a object variant, or returns None otherwise.

pub fn as_opt_mut_object(&mut self) -> Option<&mut ObjectId>

Converts this into a mut object if it is a object variant, or returns None otherwise.

pub fn into_opt_object(self) -> Option<ObjectId>

Converts this into a object if it is a object variant, or returns None otherwise.

pub fn into_object(self) -> ObjectId

Converts this into a object if it is a object variant, or panics otherwise.

pub fn is_shared(&self) -> bool

Checks if this is a shared variant.

pub fn as_shared(&self) -> &Version

Converts this into a shared if it is a shared variant, or panics otherwise.

pub fn as_mut_shared(&mut self) -> &mut Version

Converts this into a mut shared if it is a shared variant, or panics otherwise.

pub fn as_opt_shared(&self) -> Option<&Version>

Converts this into a shared if it is a shared variant, or returns None otherwise.

pub fn as_opt_mut_shared(&mut self) -> Option<&mut Version>

Converts this into a mut shared if it is a shared variant, or returns None otherwise.

pub fn into_opt_shared(self) -> Option<Version>

Converts this into a shared if it is a shared variant, or returns None otherwise.

pub fn into_shared(self) -> Version

Converts this into a shared if it is a shared variant, or panics otherwise.

pub fn address_or_object(&self) -> Option<&Address>

Returns an Address if this object is owned by an address or object, and None if it is shared or immutable.

Trait Implementations

impl Arbitrary for Owner

Available on crate feature proptest only.

type Parameters = ()

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

type Strategy = BoxedStrategy<Owner>

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

fn arbitrary_with( args_shared: <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 Clone for Owner

fn clone(&self) -> Owner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Owner

impl Debug for Owner

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

Formats the value using the given formatter.

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

Available on crate feature serde only.

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

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Owner

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Address> for Owner

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for Owner

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

Equality operator ==.

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

Inequality operator !=.

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

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Owner