Struct SchemaType 

pub struct SchemaType(/* private fields */);

A newtype wrapper around a String, representing a schema type.

A valid schema type is a name in the style of Rust namespaces, composed of one or more non-empty segments separated by ::. Each segment can contain only ASCII alphanumerics or _.

Some examples:

• u32
• felt
• miden::standards::auth::pub_key
• miden::standards::auth::scheme

Implementations

impl SchemaType

pub fn new(s: impl Into<String>) -> Result<SchemaType, SchemaTypeError>

Creates a new SchemaType from a String.

The name must follow a Rust-style namespace format, consisting of one or more segments (non-empty, and alphanumerical) separated by double-colon (::) delimiters.

Errors

• If the identifier is empty.
• If any segment is empty or contains something other than alphanumerical characters/underscores.

pub fn void() -> SchemaType

Returns the schema type for the void type.

The void type always parses to 0 and is intended to model reserved or padding felts.

pub fn native_felt() -> SchemaType

Returns the schema type for the native Felt type.

pub fn native_word() -> SchemaType

Returns the schema type for the native Word type.

pub fn u8() -> SchemaType

Returns the schema type for the native u8 type.

pub fn u16() -> SchemaType

Returns the schema type for the native u16 type.

pub fn u32() -> SchemaType

Returns the schema type for the native u32 type.

pub fn bool() -> SchemaType

Returns the schema type for the native bool type.

pub fn auth_scheme() -> SchemaType

Returns the schema type for auth scheme identifiers.

pub fn pub_key() -> SchemaType

Returns the schema type for public key commitments.

pub fn token_symbol() -> SchemaType

Returns the schema type for fungible faucet token symbols.

pub fn as_str(&self) -> &str

Returns a reference to the inner string.

Trait Implementations

impl Clone for SchemaType

fn clone(&self) -> SchemaType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SchemaType

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

Formats the value using the given formatter.

impl Deserializable for SchemaType

fn read_from<R>(source: &mut R) -> Result<SchemaType, 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 SchemaType

fn deserialize<__D>( __deserializer: __D, ) -> Result<SchemaType, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SchemaType

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

Formats the value using the given formatter.

impl Ord for SchemaType

fn cmp(&self, other: &SchemaType) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for SchemaType

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

fn partial_cmp(&self, other: &SchemaType) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable for SchemaType

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 SchemaType

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 SchemaType

impl StructuralPartialEq for SchemaType