Enum miden_objects::accounts::StorageSlotType

pub enum StorageSlotType {
    Value {
        value_arity: u8,
    },
    Map {
        value_arity: u8,
    },
    Array {
        depth: u8,
        value_arity: u8,
    },
}

An object that represents the type of a storage slot.

Variants

Value

Represents a slot that contains a value with the specified arity.

Fields

value_arity: u8

Map

Represents a slot that contains a commitment to a map with values with the specified arity.

Fields

value_arity: u8

Array

Represents a slot that contains a commitment to an array with capacity 2^depth with values with the specified arity.

Fields

depth: u8

value_arity: u8

Implementations

impl StorageSlotType

pub fn is_valid(&self) -> bool

Returns true if this storage slot type is valid.

Valid storage slot types are defined as follows:

• value arity must be between 0 and 254 (inclusive).
• for Array types, depth must be between 2 and 64 (inclusive).

pub fn is_default(&self) -> bool

Returns true if this storage slot type is a value type with arity 0.

pub fn default_word(&self) -> Word

Returns the empty Word for a value of this type.

Trait Implementations

impl Clone for StorageSlotType

fn clone(&self) -> StorageSlotType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageSlotType

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

Formats the value using the given formatter.

impl Default for StorageSlotType

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for StorageSlotType

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 From<&StorageSlotType> for Felt

fn from(value: &StorageSlotType) -> Self

Converts to this type from the input type.

impl From<&StorageSlotType> for u16

fn from(value: &StorageSlotType) -> Self

Converts to this type from the input type.

impl From<StorageSlotType> for Felt

fn from(slot_type: StorageSlotType) -> Self

Converts storage type into a field element as the following 32-bit values:

[value_arity, slot_data_type]

Where slot_data_type is 0 for Value type, 1 for Map type, and set to depth fro Array type.

impl From<StorageSlotType> for u16

fn from(slot_type: StorageSlotType) -> Self

Converts storage type into a u16 value as the following 2 bytes:

[value_arity, slot_data_type]

Where slot_data_type is 0 for Value type, 1 for Map type, and set to depth fro Array type.

impl PartialEq for StorageSlotType

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

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 TryFrom<u16> for StorageSlotType

type Error = String

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for StorageSlotType

impl Eq for StorageSlotType

impl StructuralPartialEq for StorageSlotType