Enum MapRepresentation 

pub enum MapRepresentation {
    Template {
        identifier: FieldIdentifier,
    },
    Value {
        identifier: FieldIdentifier,
        entries: Vec<MapEntry>,
    },
}

Supported map representations for a component’s storage entries.

Variants

Template

A map whose contents are provided during instantiation via placeholders.

Fields

identifier: FieldIdentifier

The human-readable identifier of the map slot.

Value

A map with statically defined key/value pairs.

Fields

identifier: FieldIdentifier

The human-readable identifier of the map slot.

entries: Vec<MapEntry>

Storage map entries, consisting of a list of keys associated with their values.

Implementations

impl MapRepresentation

pub fn new_value( entries: Vec<MapEntry>, name: impl Into<StorageValueName>, ) -> Self

Creates a new MapRepresentation from a vector of map entries.

pub fn new_template(name: impl Into<StorageValueName>) -> Self

Creates a new templated map representation.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description of the MapRepresentation and returns self.

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

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

pub fn entries(&self) -> &[MapEntry]

Returns a reference to map entries.

pub fn name(&self) -> &StorageValueName

Returns a reference to the map’s name within the storage metadata.

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

Returns a reference to the field’s description.

pub fn len(&self) -> usize

Returns the number of statically defined key-value pairs in the map.

pub fn is_empty(&self) -> bool

Returns true if there are no statically defined entries in the map.

pub fn try_build_map( &self, init_storage_data: &InitStorageData, ) -> Result<StorageMap, AccountComponentTemplateError>

Attempts to convert the MapRepresentation into a StorageMap.

If any of the inner elements are templates, their values are retrieved from init_storage_data, identified by their key.

Trait Implementations

impl Clone for MapRepresentation

fn clone(&self) -> MapRepresentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MapRepresentation

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

Formats the value using the given formatter.

impl Deserializable for MapRepresentation

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 MapRepresentation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for MapRepresentation

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

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 MapRepresentation

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 MapRepresentation

impl StructuralPartialEq for MapRepresentation