Enum Type

pub enum Type {
    Address,
    Array(ArrayType),
    Boolean,
    Composite(CompositeType),
    Field,
    Future(FutureType),
    Group,
    Identifier(Identifier),
    Integer(IntegerType),
    Mapping(MappingType),
    Optional(OptionalType),
    Scalar,
    Signature,
    String,
    Tuple(TupleType),
    Vector(VectorType),
    Numeric,
    Unit,
    Err,
}

Explicit type used for defining a variable or expression type

Variants

Address

The address type.

Array(ArrayType)

The array type.

Boolean

The bool type.

Composite(CompositeType)

The struct type.

Field

The field type.

Future(FutureType)

The future type.

Group

The group type.

Identifier(Identifier)

A reference to a built in type.

Integer(IntegerType)

An integer type.

Mapping(MappingType)

A mapping type.

Optional(OptionalType)

A nullable type.

Scalar

The scalar type.

Signature

The signature type.

String

The string type.

Tuple(TupleType)

A static tuple of at least one type.

Vector(VectorType)

The vector type.

Numeric

Numeric type which should be resolved to Field, Group, Integer(_), or Scalar.

Unit

The unit type.

Err

Placeholder for a type that could not be resolved or was not well-formed. Will eventually lead to a compile error.

Implementations

impl Type

pub fn eq_user(&self, other: &Type) -> bool

Are the types considered equal as far as the Leo user is concerned?

In particular, any comparison involving an Err is true, and Futures which aren’t explicit compare equal to other Futures.

An array with an undetermined length (e.g., one that depends on a const) is considered equal to other arrays if their element types match. This allows const propagation to potentially resolve the length before type checking is performed again.

Composite types are considered equal if their names and resolved program names match. If either side still has const generic arguments, they are treated as equal unconditionally since monomorphization and other passes of type-checking will handle mismatches later.

pub fn eq_flat_relaxed(&self, other: &Self) -> bool

Returns true if the self Type is equal to the other Type in all aspects besides composite program of origin.

In the case of futures, it also makes sure that if both are not explicit, they are equal.

Flattens array syntax: [[u8; 1]; 2] == [u8; (2, 1)] == true

Composite types are considered equal if their names match. If either side still has const generic arguments, they are treated as equal unconditionally since monomorphization and other passes of type-checking will handle mismatches later.

pub fn from_snarkvm<N: Network>( t: &PlaintextType<N>, program: Option<Symbol>, ) -> Self

pub fn to_snarkvm<N: Network>(&self) -> Result<PlaintextType<N>>

pub fn size_in_bits<N: Network, F>( &self, is_raw: bool, get_structs: F, ) -> Result<usize>

where F: Fn(&Identifier<N>) -> Result<StructType<N>>,

pub fn can_coerce_to(&self, expected: &Type) -> bool

Determines whether self can be coerced to the expected type.

This method checks if the current type can be implicitly coerced to the expected type according to specific rules:

• Optional<T> can be coerced to Optional<T>.
• T can be coerced to Optional<T>.
• Arrays [T; N] can be coerced to [Optional<T>; N] if lengths match or are unknown, and element types are coercible.
• Falls back to an equality check for other types.

Arguments

• expected - The type to which self is being coerced.

Returns

true if coercion is allowed; false otherwise.

pub fn is_optional(&self) -> bool

pub fn is_vector(&self) -> bool

pub fn is_mapping(&self) -> bool

pub fn to_optional(&self) -> Type

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl Default for Type

fn default() -> Type

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Type

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Type

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

Formats the value using the given formatter.

impl From<ArrayType> for Type

fn from(value: ArrayType) -> Self

Converts to this type from the input type.

impl From<CompositeType> for Type

fn from(value: CompositeType) -> Self

Converts to this type from the input type.

impl From<FutureType> for Type

fn from(value: FutureType) -> Self

Converts to this type from the input type.

impl From<LiteralType> for Type

fn from(value: LiteralType) -> Self

Converts to this type from the input type.

impl From<TupleType> for Type

fn from(value: TupleType) -> Self

Converts to this type from the input type.

impl From<VectorType> for Type

fn from(value: VectorType) -> Self

Converts to this type from the input type.

impl PartialEq for Type

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

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 Type

impl StructuralPartialEq for Type