Struct StorageSlotName 

pub struct StorageSlotName { /* private fields */ }

The name of an account storage slot.

A typical slot name looks like this:

miden::standards::fungible_faucets::metadata

The double-colon (::) serves as a separator and the strings in between the separators are called components.

It is generally recommended that slot names have at least three components and follow this structure:

project_name::component_name::slot_name

Requirements

For a string to be a valid slot name it needs to satisfy the following criteria:

• Its length must be less than 255.
• It needs to have at least 2 components.
• Each component must consist of at least one character.
• Each component must only consist of the characters a to z, A to Z, 0 to 9 or _ (underscore).
• Each component must not start with an underscore.

Implementations

impl StorageSlotName

pub fn new( name: impl Into<Arc<str>>, ) -> Result<StorageSlotName, StorageSlotNameError>

Constructs a new StorageSlotName from a string.

Errors

Returns an error if:

• the slot name is invalid (see the type-level docs for the requirements).

pub fn as_str(&self) -> &str

Returns the slot name as a string slice.

pub fn len(&self) -> u8

Returns the slot name as a string slice.

pub fn id(&self) -> StorageSlotId

Returns the StorageSlotId derived from the slot name.

Trait Implementations

impl Clone for StorageSlotName

fn clone(&self) -> StorageSlotName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageSlotName

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

Formats the value using the given formatter.

impl Deserializable for StorageSlotName

fn read_from<R>(source: &mut R) -> Result<StorageSlotName, DeserializationError>

where R: ByteReader,

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 Display for StorageSlotName

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

Formats the value using the given formatter.

impl From<&StorageSlotName> for StorageValueName

fn from(value: &StorageSlotName) -> StorageValueName

Converts to this type from the input type.

impl From<StorageSlotName> for String

fn from(slot_name: StorageSlotName) -> String

Converts to this type from the input type.

impl FromStr for StorageSlotName

type Err = StorageSlotNameError

The associated error which can be returned from parsing.

fn from_str( string: &str, ) -> Result<StorageSlotName, <StorageSlotName as FromStr>::Err>

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

impl Hash for StorageSlotName

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for StorageSlotName

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

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

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

Serializes self into bytes and writes these bytes into the target.

fn get_size_hint(&self) -> usize

Returns an estimate of how many bytes are needed to represent self.

fn to_bytes(&self) -> Vec<u8>

Serializes self into a vector of bytes.

impl Eq for StorageSlotName

impl StructuralPartialEq for StorageSlotName