Struct FeltSchema 

pub struct FeltSchema { /* private fields */ }

Supported element schema descriptors for a component’s storage entries.

Each felt element in a composed word slot is typed, can have an optional default value, and can optionally be named to allow overriding at instantiation time.

To avoid non-overridable constants, unnamed elements are allowed only when type = "void", which always evaluates to 0 and does not require init data.

Implementations

impl FeltSchema

pub fn new_typed(type: SchemaType, name: impl Into<String>) -> FeltSchema

Creates a new required typed felt field.

pub fn new_typed_with_default( type: SchemaType, name: impl Into<String>, default_value: Felt, ) -> FeltSchema

Creates a new typed felt field with a default value.

pub fn new_void() -> FeltSchema

Creates an unnamed void felt element.

pub fn felt(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::native_felt().

pub fn word(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::native_word().

pub fn u8(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::u8().

pub fn u16(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::u16().

pub fn u32(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::u32().

pub fn bool(name: impl Into<String>) -> FeltSchema

Creates a new required felt field typed as SchemaType::bool().

pub fn with_default(self, default_value: Felt) -> FeltSchema

Sets the default value of the FeltSchema and returns self.

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

Sets the description of the FeltSchema and returns self.

pub fn felt_type(&self) -> SchemaType

Returns the felt type.

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

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

pub fn default_value(&self) -> Option<Felt>

Trait Implementations

impl Clone for FeltSchema

fn clone(&self) -> FeltSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FeltSchema

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

Formats the value using the given formatter.

impl Deserializable for FeltSchema

fn read_from<R>(source: &mut R) -> Result<FeltSchema, DeserializationError>

where R: ByteReader,

Reads a sequence of bytes from the provided source, attempts to deserialize these bytes into Self, and returns the result.

fn min_serialized_size() -> usize

Returns the minimum serialized size for one instance of this type.

fn read_from_bytes(bytes: &[u8]) -> Result<Self, DeserializationError>

Attempts to deserialize the provided bytes into Self and returns the result.

fn read_from_bytes_with_budget( bytes: &[u8], budget: usize, ) -> Result<Self, DeserializationError>

Deserializes Self from bytes with a byte budget limit.

impl<'de> Deserialize<'de> for FeltSchema

fn deserialize<D>( deserializer: D, ) -> Result<FeltSchema, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FeltSchema

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

fn write_into<W>(&self, target: &mut W)

where W: ByteWriter,

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 FeltSchema

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FeltSchema

impl StructuralPartialEq for FeltSchema