Enum WordSchema 

pub enum WordSchema {
    Simple {
        type: SchemaTypeId,
        default_value: Option<Word>,
    },
    Composite {
        value: [FeltSchema; 4],
    },
}

Defines how a word slot is described within the component’s storage schema.

Each word schema can either describe a whole-word typed value supplied at instantiation time (Simple) or a composite word that explicitly defines each felt element (Composite).

Variants

Simple

A whole-word typed value supplied at instantiation time.

Fields

type: SchemaTypeId

default_value: Option<Word>

Composite

A composed word that may mix defaults and typed fields.

Fields

value: [FeltSchema; 4]

Implementations

impl WordSchema

pub fn new_simple(type: SchemaTypeId) -> Self

pub fn new_simple_with_default(type: SchemaTypeId, default_value: Word) -> Self

pub fn new_value(value: impl Into<[FeltSchema; 4]>) -> Self

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

pub fn word_type(&self) -> SchemaTypeId

Returns the schema type identifier associated with whole-word init-supplied values.

Trait Implementations

impl Clone for WordSchema

fn clone(&self) -> WordSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WordSchema

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

Formats the value using the given formatter.

impl Deserializable for WordSchema

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

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

Converts to this type from the input type.

impl From<[FeltSchema; 4]> for WordSchema

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

Converts to this type from the input type.

impl PartialEq for WordSchema

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

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 Eq for WordSchema

impl StructuralPartialEq for WordSchema