Struct StorageValueName

pub struct StorageValueName { /* private fields */ }

A simple wrapper type around a string key that identifies values.

A storage value name is a string that identifies dynamic values within a component’s metadata storage entries.

These names can be chained together, in a way that allows composing unique keys for inner templated elements.

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

Implementations

impl StorageValueName

pub fn new(base: impl Into<String>) -> Result<Self, StorageValueNameError>

Creates a new StorageValueName from the provided string.

A StorageValueName 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 with_suffix(self, suffix: &StorageValueName) -> StorageValueName

Adds a suffix to the storage value name, separated by a period.

pub fn as_str(&self) -> &str

Returns the fully qualified name as a string slice.

Trait Implementations

impl Clone for StorageValueName

fn clone(&self) -> StorageValueName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageValueName

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

Formats the value using the given formatter.

impl Deserializable for StorageValueName

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 StorageValueName

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StorageValueName

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

Formats the value using the given formatter.

impl Ord for StorageValueName

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

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

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

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 StorageValueName

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 StorageValueName

impl StructuralPartialEq for StorageValueName