Struct InitStorageData 

pub struct InitStorageData { /* private fields */ }

Represents the data required to initialize storage entries when instantiating an AccountComponent from component metadata (either provided directly or extracted from a package).

An InitStorageData can be created from a TOML string when the std feature flag is set.

Implementations

impl InitStorageData

pub fn new( value_entries: BTreeMap<StorageValueName, WordValue>, map_entries: BTreeMap<StorageSlotName, Vec<(WordValue, WordValue)>>, ) -> Result<Self, InitStorageDataError>

Creates a new instance of InitStorageData, validating that there are no conflicting entries.

Errors

Returns an error if:

• A slot has both value entries and map entries
• A slot has both a slot-level value and field values

pub fn values(&self) -> &BTreeMap<StorageValueName, WordValue>

Returns a reference to the underlying init values map.

pub fn maps(&self) -> &BTreeMap<StorageSlotName, Vec<(WordValue, WordValue)>>

Returns a reference to the underlying init map entries.

pub fn value_entry(&self, name: &StorageValueName) -> Option<&WordValue>

Returns a reference to the stored init value for the given name.

pub fn slot_value_entry( &self, slot_name: &StorageSlotName, ) -> Option<&WordValue>

Returns a reference to the stored init value for a full slot name.

pub fn map_entries( &self, slot_name: &StorageSlotName, ) -> Option<&Vec<(WordValue, WordValue)>>

Returns the map entries associated with the given storage map slot name, if any.

pub fn has_value_entries_for_slot(&self, slot_name: &StorageSlotName) -> bool

Returns true if any init value entry targets the given slot name.

pub fn has_field_entries_for_slot(&self, slot_name: &StorageSlotName) -> bool

Returns true if any init value entry targets a field of the given slot name.

pub fn insert_value( &mut self, name: StorageValueName, value: impl Into<WordValue>, ) -> Result<(), InitStorageDataError>

Inserts a value entry, returning an error on duplicate or conflicting keys.

The value can be any type that implements Into<WordValue>, e.g.:

• Word: a fully-typed word value
• [Felt; 4]: converted to a Word
• Felt: converted to [0, 0, 0, felt]
• String or &str: a parseable string value
• WordValue: a word value (fully typed, atomic, or elements)

pub fn set_value( &mut self, name: StorageValueName, value: impl Into<WordValue>, ) -> Result<(), InitStorageDataError>

Sets a value entry, overriding any existing entry for the name.

Returns an error if the StorageValueName has been used for a map slot.

pub fn insert_map_entry( &mut self, slot_name: StorageSlotName, key: impl Into<WordValue>, value: impl Into<WordValue>, ) -> Result<(), InitStorageDataError>

Inserts a single map entry, returning an error on duplicate or conflicting keys.

See Self::insert_value for examples of supported types for key and value.

pub fn set_map_values( &mut self, slot_name: StorageSlotName, entries: Vec<(WordValue, WordValue)>, ) -> Result<(), InitStorageDataError>

Sets map entries for the slot, replacing any existing entries.

Returns an error if there are conflicting value entries.

pub fn merge_with(&mut self, other: InitStorageData)

Merges another InitStorageData into this one, overwriting value entries and appending map entries.

pub fn merge_from(&mut self, other: InitStorageData)

Merges another InitStorageData into this one, overwriting value entries and appending map entries.

impl InitStorageData

pub fn from_toml(toml_str: &str) -> Result<Self, InitStorageDataError>

Creates an instance of InitStorageData from a TOML string.

Supported formats

# Value entry (string)
"slot::name" = "0x1234"

# Value entry (4-element word)
"slot::name" = ["0", "0", "0", "100"]

# Nested table (flattened to slot::name.field)
["slot::name"]
field = "value"

# Map entries
"slot::map" = [
    { key = "0x01", value = "0x10" },
]

Trait Implementations

impl Clone for InitStorageData

fn clone(&self) -> InitStorageData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InitStorageData

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

Formats the value using the given formatter.

impl Default for InitStorageData

fn default() -> InitStorageData

Returns the “default value” for a type.