Enum WordRepresentation

pub enum WordRepresentation {
    Value([Felt; 4]),
    Array([FeltRepresentation; 4]),
    Template(StoragePlaceholder),
}

Supported word representations. Represents slot values and keys.

Variants

Value([Felt; 4])

A word represented by its four felts.

Array([FeltRepresentation; 4])

A word represented by 4 FeltRepresentation.

Template(StoragePlaceholder)

A placeholder value, represented as “{{key}}”, where key is the inner value of the StoragePlaceholder.

Implementations

impl WordRepresentation

pub fn all_placeholders_iter( &self, ) -> Box<dyn Iterator<Item = (&StoragePlaceholder, PlaceholderType)> + '_>

Returns an iterator over all storage placeholder references within the WordRepresentation along with their expected types

pub fn try_build_word( &self, init_storage_data: &InitStorageData, ) -> Result<Word, AccountComponentTemplateError>

Attempts to convert the WordRepresentation into a Word.

If the representation is a template, the value is retrieved from init_storage_data, identified by its key. If any of the inner elements within the value are a template, they are retrieved in the same way.

Trait Implementations

impl Clone for WordRepresentation

fn clone(&self) -> WordRepresentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WordRepresentation

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

Formats the value using the given formatter.

impl Default for WordRepresentation

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for WordRepresentation

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 WordRepresentation

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for WordRepresentation

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

Formats the value using the given formatter.

impl From<[BaseElement; 4]> for WordRepresentation

fn from(value: Word) -> Self

Converts to this type from the input type.

impl PartialEq for WordRepresentation

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

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 WordRepresentation

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 WordRepresentation

impl StructuralPartialEq for WordRepresentation