Enum ObjectChange 

#[non_exhaustive]
pub enum ObjectChange<'a> {
    Created {
        object_id: &'a Address,
        output_version: Version,
        output_digest: &'a Digest,
        output_owner: &'a Owner,
    },
    Mutated {
        object_id: &'a Address,
        input_version: Option<Version>,
        input_digest: Option<&'a Digest>,
        input_owner: Option<&'a Owner>,
        output_version: Version,
        output_digest: &'a Digest,
        output_owner: &'a Owner,
    },
    Unwrapped {
        object_id: &'a Address,
        output_version: Version,
        output_digest: &'a Digest,
        output_owner: &'a Owner,
    },
    Deleted {
        object_id: &'a Address,
        input_version: Option<Version>,
        input_digest: Option<&'a Digest>,
        input_owner: Option<&'a Owner>,
    },
    Wrapped {
        object_id: &'a Address,
        input_version: Option<Version>,
        input_digest: Option<&'a Digest>,
        input_owner: Option<&'a Owner>,
    },
    UnwrappedThenDeleted {
        object_id: &'a Address,
    },
}

A per-object change reported by a transaction’s effects.

This is a unified, classified view over both V1 and V2 effects. Each variant carries the fields that are meaningful for that kind of change.

Address, Digest, and Owner fields are borrowed from the underlying effects rather than copied, so the enum is parameterised by the lifetime of the borrowed TransactionEffects. Version (a u64) is returned by value, since a reference to it would not be any smaller.

Fields that V1 effects do not store (input digests, input owners) are modelled as Option, and are always None for V1-sourced changes.

The enum is #[non_exhaustive] because the Sui protocol may add new kinds of object change in the future; pattern matches on it should include a catch-all arm.

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.

Created

A new object was created by this transaction.

Fields

object_id: &'a Address

output_version: Version

output_digest: &'a Digest

output_owner: &'a Owner

Mutated

An existing object’s contents (and possibly owner) were modified by this transaction.

Fields

object_id: &'a Address

input_version: Option<Version>

The object’s version before execution.

Always Some on V2 effects (read from ObjectIn::Exist). On V1 effects this is looked up in the effects’ modified_at_versions table, which may be absent for malformed effects; in that case it is None.

input_digest: Option<&'a Digest>

The object’s digest before execution. None on V1 effects.

input_owner: Option<&'a Owner>

The object’s owner before execution. None on V1 effects.

output_version: Version

output_digest: &'a Digest

output_owner: &'a Owner

Unwrapped

A previously wrapped object was extracted (unwrapped) by this transaction and now appears at the root level of the object store.

Fields

object_id: &'a Address

output_version: Version

output_digest: &'a Digest

output_owner: &'a Owner

Deleted

An object was deleted by this transaction.

Fields

object_id: &'a Address

input_version: Option<Version>

The object’s version before deletion. See ObjectChange::Mutated for when this may be None.

input_digest: Option<&'a Digest>

input_owner: Option<&'a Owner>

Wrapped

An object was wrapped inside another object by this transaction (and is therefore no longer at the root level of the object store).

Fields

object_id: &'a Address

input_version: Option<Version>

The object’s version before being wrapped. See ObjectChange::Mutated for when this may be None.

input_digest: Option<&'a Digest>

input_owner: Option<&'a Owner>

UnwrappedThenDeleted

An object was unwrapped and then deleted in the same transaction. Neither the prior nor the new state is recorded.

Fields

object_id: &'a Address

Implementations

impl<'a> ObjectChange<'a>

pub fn object_id(&self) -> &'a Address

The id of the object affected by this change.

Trait Implementations

impl<'a> Clone for ObjectChange<'a>

fn clone(&self) -> ObjectChange<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ObjectChange<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for ObjectChange<'a>

fn eq(&self, other: &ObjectChange<'a>) -> 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<'a> Copy for ObjectChange<'a>

impl<'a> Eq for ObjectChange<'a>

impl<'a> StructuralPartialEq for ObjectChange<'a>