Enum WordRepresentation

pub enum WordRepresentation {
    Template {
        type: TemplateType,
        name: StorageValueName,
        description: Option<String>,
    },
    Value {
        name: Option<StorageValueName>,
        description: Option<String>,
        value: [FeltRepresentation; 4],
    },
}

Defines how a word is represented within the component’s storage description.

Each word representation can be:

• A template that defines a type but does not carry a value.
• A predefined value that may contain a hardcoded word or a mix of fixed and templated felts.

Variants

Template

A templated value that serves as a placeholder for instantiation.

This variant defines a type but does not store a value. The actual value is provided at the time of instantiation. The name is required to identify this template externally.

Fields

type: TemplateType

The type associated with this templated word.

name: StorageValueName

A human-readable identifier for the template.

description: Option<String>

An optional description explaining the purpose of this template.

Value

A predefined value that can be used directly within storage.

This variant may contain either a fully hardcoded word or a structured set of felts, some of which may themselves be templates.

Fields

name: Option<StorageValueName>

An optional name to identify this value externally.

description: Option<String>

An optional description explaining the role of this value.

value: [FeltRepresentation; 4]

The 4-felt representation of the stored word.

Implementations

impl WordRepresentation

pub fn new_template(type: TemplateType, name: StorageValueName) -> Self

Constructs a new Template variant.

pub fn new_value( value: impl Into<[FeltRepresentation; 4]>, name: Option<StorageValueName>, ) -> Self

Constructs a new Value variant.

pub fn with_description(self, description: impl Into<String>) -> Self

Sets the description of the WordRepresentation and returns self.

pub fn name(&self) -> Option<&StorageValueName>

Returns the name associated with the word representation.

• For the Template variant, it always returns a reference to the name.
• For the Value variant, it returns Some if a name is present, or None otherwise.

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

Returns the description associated with the word representation. Both variants store an Option<String>, which is converted to an Option<&str>.

pub fn word_type(&self) -> TemplateType

Returns the type name.

pub fn value(&self) -> Option<&[FeltRepresentation; 4]>

Returns the value (an array of 4 FeltRepresentations) if this is a Value variant; otherwise, returns None.

pub fn template_requirements( &self, placeholder_prefix: StorageValueName, ) -> Box<dyn Iterator<Item = (StorageValueName, PlaceholderTypeRequirement)> + '_>

Returns an iterator over the word’s placeholders.

For WordRepresentation::Value, it corresponds to the inner iterators (since inner elements can be templated as well). For WordRepresentation::Template it returns the words’s placeholder requirements as defined.

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 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 From<[BaseElement; 4]> for WordRepresentation

fn from(value: [Felt; 4]) -> Self

Converts to this type from the input type.

impl From<[FeltRepresentation; 4]> for WordRepresentation

fn from(value: [FeltRepresentation; 4]) -> 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