Struct StorageValueName 

pub struct StorageValueName { /* private fields */ }

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

A storage value name is a string that identifies values supplied during component instantiation (via InitStorageData).

Each name is either a storage slot name, or a storage slot name with a suffixed identifier for composite types (where the suffix identifies the inner type).

Implementations

impl StorageValueName

pub fn from_slot_name(slot_name: &StorageSlotName) -> Self

Creates a StorageValueName for the given storage slot.

pub fn from_slot_name_with_suffix( slot_name: &StorageSlotName, suffix: &str, ) -> Result<StorageValueName, StorageValueNameError>

Creates a StorageValueName for the given storage slot and field suffix.

A suffixed slot name is used to identify a specific field element’s type in a schema (e.g., miden::contracts::fungible_faucets::token_metadata.max_supply can specify the max_supply element in the token_metadata storage slot)

pub fn slot_name(&self) -> &StorageSlotName

Returns the storage slot name prefix of this value name.

pub fn field_name(&self) -> Option<&str>

Returns the optional field suffix of this value name.

Trait Implementations

impl Clone for StorageValueName

fn clone(&self) -> StorageValueName

Returns a duplicate 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 From<&StorageSlotName> for StorageValueName

fn from(value: &StorageSlotName) -> Self

Converts to this type from the input type.

impl From<StorageValueName> for String

fn from(value: StorageValueName) -> Self

Converts to this type from the input type.

impl FromStr for StorageValueName

type Err = StorageValueNameError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for StorageValueName

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

type Error = StorageValueNameError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for StorageValueName