Struct StorageSchema 

pub struct StorageSchema { /* private fields */ }

Describes the storage schema of an account component in terms of its named storage slots.

Implementations

impl StorageSchema

pub fn new( slots: impl IntoIterator<Item = (StorageSlotName, StorageSlotSchema)>, ) -> Result<Self, AccountComponentTemplateError>

Creates a new StorageSchema.

Errors

• If fields contains duplicate slot names.
• If fields contains the protocol-reserved faucet metadata slot name.
• If any slot schema is invalid.
• If multiple schema fields map to the same init value name.

pub fn iter( &self, ) -> impl Iterator<Item = (&StorageSlotName, &StorageSlotSchema)>

Returns an iterator over (slot_name, schema) pairs in slot-id order.

pub fn slots(&self) -> &BTreeMap<StorageSlotName, StorageSlotSchema>

Returns a reference to the underlying slots map.

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

Builds the initial StorageSlots for this schema using the provided initialization data.

pub fn commitment(&self) -> Word

Returns a commitment to this storage schema definition.

The commitment is computed over the serialized schema and does not include defaults.

pub fn schema_requirements( &self, ) -> Result<BTreeMap<StorageValueName, SchemaRequirement>, AccountComponentTemplateError>

Returns init-value requirements for the entire schema.

The returned map includes both required values (no default_value) and optional values (with default_value), and excludes map entries.

Trait Implementations

impl Clone for StorageSchema

fn clone(&self) -> StorageSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageSchema

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

Formats the value using the given formatter.

impl Default for StorageSchema

fn default() -> StorageSchema

Returns the “default value” for a type.

impl Deserializable for StorageSchema

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 StorageSchema

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StorageSchema

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

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 StorageSchema

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 StorageSchema

impl StructuralPartialEq for StorageSchema