Enum StorageEntry

pub enum StorageEntry {
    Value {
        slot: u8,
        word_entry: WordRepresentation,
    },
    Map {
        slot: u8,
        map: MapRepresentation,
    },
    MultiSlot {
        slots: Range<u8>,
        word_entries: MultiWordRepresentation,
    },
}

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 word.

Fields

slot: u8

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

word_entry: WordRepresentation

A description of a word, representing either a predefined value or a templated one.

Map

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

Fields

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

slots: Range<u8>

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

word_entries: MultiWordRepresentation

A description of the values.

Implementations

impl StorageEntry

pub fn new_value(slot: u8, word_entry: impl Into<WordRepresentation>) -> Self

pub fn new_map(slot: u8, map: MapRepresentation) -> Self

pub fn new_multislot( identifier: FieldIdentifier, slots: Range<u8>, values: Vec<[FeltRepresentation; 4]>, ) -> Self

pub fn name(&self) -> Option<&StorageValueName>

pub fn slot_indices(&self) -> Range<u8>

Returns the slot indices that the storage entry covers.

pub fn template_requirements(&self) -> TemplateRequirementsIter<'_>

Returns an iterator over all of the storage entries’s value names, 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 required by the defined type
• 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