Enum FeltRepresentation

pub enum FeltRepresentation {
    Value {
        identifier: Option<FieldIdentifier>,
        value: Felt,
    },
    Template {
        type: TemplateType,
        identifier: FieldIdentifier,
    },
}

Supported element representations for a component’s storage entries.

Each felt element in a storage entry can either be:

• A concrete value that holds a predefined felt.
• A template that specifies the type of felt expected, with the actual value to be provided later.

Variants

Value

A concrete felt value.

This variant holds a felt that is part of the component’s storage. The optional name allows for identification, and the description offers additional context.

Fields

identifier: Option<FieldIdentifier>

An optional identifier for this felt value. An optional explanation of the felt’s purpose.

value: Felt

The actual felt value.

Template

A templated felt element.

This variant specifies the expected type of the felt without providing a concrete value. The name is required to uniquely identify the template, and an optional description can further clarify its intended use.

Fields

type: TemplateType

The expected type for this felt element.

identifier: FieldIdentifier

A unique name for the felt template. An optional description that explains the purpose of this template.

Implementations

impl FeltRepresentation

pub fn new_value(value: impl Into<Felt>, name: Option<StorageValueName>) -> Self

Creates a new FeltRepresentation::Value variant.

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

Creates a new FeltRepresentation::Template variant.

The name will be used for identification at the moment of instantiating the componentn.

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

Sets the description of the FeltRepresentation and returns self.

pub fn felt_type(&self) -> TemplateType

Returns the felt type.

pub fn template_requirements( &self, placeholder_prefix: StorageValueName, ) -> TemplateRequirementsIter<'_>

Returns an iterator over the felt’s template.

For FeltRepresentation::Value, these is an empty set; for FeltRepresentation::Template it returns the felt’s placeholder key based on the felt’s name within the component description.

Trait Implementations

impl Clone for FeltRepresentation

fn clone(&self) -> FeltRepresentation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeltRepresentation

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

Formats the value using the given formatter.

impl Default for FeltRepresentation

fn default() -> Self

Returns the “default value” for a type.

impl Deserializable for FeltRepresentation

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 FeltRepresentation

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BaseElement> for FeltRepresentation

fn from(value: Felt) -> Self

Converts to this type from the input type.

impl PartialEq for FeltRepresentation

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

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 FeltRepresentation

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 FeltRepresentation

impl StructuralPartialEq for FeltRepresentation