Struct StateUpdates 

pub struct StateUpdates {
    pub by_node: IndexMap<NodeId, NodeStateUpdates>,
}

A tree-like description of all updates that happened to a stored state, to be included as a part of a transaction receipt. This structure is indexed (i.e. uses IndexMaps where Vecs could be used) for convenience and performance, since both the source (i.e. Track) and the sink (i.e. Database and API) operate on indexed structures too. This structure maintains partial information on the order of operations (please see individual fields for details), since the end users care about it. Please note that this means multiple instances of StateUpdates can represent the same transform of state store (i.e. differing only by order of some operations), and hence it is not 100% “canonical form”.

Fields

by_node: IndexMap<NodeId, NodeStateUpdates>

Indexed Node-level updates, captured in the order of first update operation to a Node.

Implementations

impl StateUpdates

pub fn empty() -> Self

pub fn of_node(&mut self, node_id: impl Into<NodeId>) -> &mut NodeStateUpdates

Starts a Node-level update.

pub fn set_node_updates( self, node_id: impl Into<NodeId>, node_updates: NodeStateUpdates, ) -> Self

pub fn set_substate<'a>( self, node_id: impl Into<NodeId>, partition_num: PartitionNumber, substate_key: impl ResolvableSubstateKey<'a>, new_value: impl ScryptoEncode, ) -> Self

pub fn rebuild_without_empty_entries(self) -> Self

pub fn into_flattened_substate_updates( self, ) -> IndexMap<(NodeId, PartitionNumber, SubstateKey), DatabaseUpdate>

Roughly equivalent to the LegacyStateUpdates (when they existed), ignoring partition resets. Should only be used for tests, not e.g. for committing to a database.

Trait Implementations

impl<X: CustomValueKind> Categorize<X> for StateUpdates

fn value_kind() -> ValueKind<X>

impl Clone for StateUpdates

fn clone(&self) -> StateUpdates

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StateUpdates

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

Formats the value using the given formatter.

impl<D: Decoder<X>, X: CustomValueKind> Decode<X, D> for StateUpdates

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X>, ) -> Result<Self, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl Default for StateUpdates

fn default() -> StateUpdates

Returns the “default value” for a type.

impl<C: CustomTypeKind<RustTypeId>> Describe<C> for StateUpdates

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E: Encoder<X>, X: CustomValueKind> Encode<X, E> for StateUpdates

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl PartialEq for StateUpdates

fn eq(&self, other: &StateUpdates) -> 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<X: CustomValueKind> SborTuple<X> for StateUpdates

fn get_length(&self) -> usize

impl Eq for StateUpdates

impl StructuralPartialEq for StateUpdates