Struct StoragePlaceholder

pub struct StoragePlaceholder { /* private fields */ }

A simple wrapper type around a string key that enables templating.

A storage placeholder is a string that identifies dynamic values within a component’s metadata storage entries. Storage placeholders are serialized as “{{key}}” and can be used as placeholders in map keys, map values, or individual Felts within a Word.

At component instantiation, a map of keys to StorageValue must be provided to dynamically replace these placeholders with the instance’s actual values.

Implementations

impl StoragePlaceholder

pub fn new(key: impl Into<String>) -> Result<Self, StoragePlaceholderError>

Creates a new StoragePlaceholder from the provided string.

A StoragePlaceholder serves as an identifier for storage values that are determined at instantiation time of an AccountComponentTemplate.

The key can consist of one or more segments separated by dots (.).
Each segment must be non-empty and may contain only alphanumeric characters, underscores (_), or hyphens (-).

Errors

This method returns an error if:

• Any segment (or the whole key) is empty.
• Any segment contains invalid characters.

pub fn inner(&self) -> &str

Returns the key name

Trait Implementations

impl Clone for StoragePlaceholder

fn clone(&self) -> StoragePlaceholder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StoragePlaceholder

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

Formats the value using the given formatter.

impl Deserializable for StoragePlaceholder

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 StoragePlaceholder

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StoragePlaceholder

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

Formats the value using the given formatter.

impl Ord for StoragePlaceholder

fn cmp(&self, other: &StoragePlaceholder) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for StoragePlaceholder

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

fn partial_cmp(&self, other: &StoragePlaceholder) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable for StoragePlaceholder

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 StoragePlaceholder

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&String> for StoragePlaceholder

type Error = StoragePlaceholderError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for StoragePlaceholder

type Error = StoragePlaceholderError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for StoragePlaceholder

impl StructuralPartialEq for StoragePlaceholder