Enum StorageEntry

pub enum StorageEntry {
    Value {
        name: String,
        description: Option<String>,
        slot: u8,
        value: WordRepresentation,
    },
    Map {
        name: String,
        description: Option<String>,
        slot: u8,
        map: MapRepresentation,
    },
    MultiSlot {
        name: String,
        description: Option<String>,
        slots: Vec<u8>,
        values: Vec<WordRepresentation>,
    },
}

Represents a single entry in the component’s storage layout.

Each entry can describe:

• A value slot with a single word.
• A map slot with a key-value map that occupies one storage slot.
• A multi-slot entry spanning multiple contiguous slots with multiple words (but not maps) that represent a single logical value.

Variants

Value

A value slot, which can contain one or more words. Each word is a hex-encoded string.

Fields

name: String

The human-readable name of the slot.

description: Option<String>

An optional description for the slot, explaining its purpose.

slot: u8

The numeric index of this slot in the component’s storage layout.

value: WordRepresentation

The initial value for this slot.

Map

A map slot, containing multiple key-value pairs. Keys and values are hex-encoded strings.

Fields

name: String

The human-readable name of the map slot.

description: Option<String>

An optional description for the slot, explaining its purpose.

slot: u8

The numeric index of this map slot in the component’s storage.

map: MapRepresentation

A list of key-value pairs to initialize in this map slot.

MultiSlot

A multi-slot entry, representing a single logical value across multiple slots.

Fields

name: String

The human-readable name of this multi-slot entry.

description: Option<String>

An optional description for the slot, explaining its purpose.

slots: Vec<u8>

The indices of the slots that form this multi-slot entry.

values: Vec<WordRepresentation>

A list of values to fill the logical slot, with a length equal to the amount of slots.

Implementations

impl StorageEntry

pub fn new_value( name: impl Into<String>, description: Option<impl Into<String>>, slot: u8, value: impl Into<WordRepresentation>, ) -> Self

Creates a new StorageEntry::Value variant.

pub fn new_map( name: impl Into<String>, description: Option<impl Into<String>>, slot: u8, map_representation: MapRepresentation, ) -> Result<Self, AccountComponentTemplateError>

Creates a new StorageEntry::Map variant.

pub fn new_multi_slot( name: impl Into<String>, description: Option<impl Into<String>>, slots: Vec<u8>, values: Vec<impl Into<WordRepresentation>>, ) -> Result<Self, AccountComponentTemplateError>

Creates a new StorageEntry::MultiSlot variant.

pub fn slot_indices(&self) -> &[u8]

Returns the slot indices that the storage entry covers.

pub fn name(&self) -> &str

Returns the name of the storage entry.

pub fn description(&self) -> Option<&str>

Returns the optional description of the storage entry.

pub fn word_values(&self) -> &[WordRepresentation]

Returns all the WordRepresentation values covered by this entry. For Value entries, this returns a single-element slice. For MultiSlot entries, this returns all values. For Map entries, since they’re key-value pairs, return an empty slice.

pub fn all_placeholders_iter( &self, ) -> Box<dyn Iterator<Item = (&StoragePlaceholder, PlaceholderType)> + '_>

Returns an iterator over all of the storage entries’s placeholder keys, alongside their expected type.

pub fn try_build_storage_slots( &self, init_storage_data: &InitStorageData, ) -> Result<Vec<StorageSlot>, AccountComponentTemplateError>

Attempts to convert the storage entry into a list of StorageSlot.

• StorageEntry::Value would convert to a StorageSlot::Value
• StorageEntry::MultiSlot would convert to as many StorageSlot::Value as defined
• StorageEntry::Map would convert to a StorageSlot::Map

Each of the entry’s values could be templated. These values are replaced for values found in init_storage_data, identified by its key.

Trait Implementations

impl Clone for StorageEntry

fn clone(&self) -> StorageEntry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageEntry

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

Formats the value using the given formatter.

impl Deserializable for StorageEntry

fn read_from<R: ByteReader>( source: &mut R, ) -> Result<Self, DeserializationError>

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

impl<'de> Deserialize<'de> for StorageEntry

fn deserialize<D>(deserializer: D) -> Result<StorageEntry, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StorageEntry

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

fn write_into<W: ByteWriter>(&self, target: &mut W)

Serializes self into bytes and writes these bytes into the target.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

impl Serialize for StorageEntry

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 StorageEntry

impl StructuralPartialEq for StorageEntry