Struct Type 

pub struct Type {
    pub is_final: bool,
    pub supertype: Option<TypeId>,
    pub name: Option<String>,
    /* private fields */
}

A WebAssembly type definition.

With the GC proposal, types can be function types, struct types, or array types, and can participate in subtyping and recursive type groups.

Fields

is_final: bool

Whether this type is final (cannot be further subtyped). Defaults to true for types without explicit subtype declarations.

supertype: Option<TypeId>

Optional supertype that this type extends.

name: Option<String>

An optional name for debugging.

This is not really used by anything currently, but a theoretical WAT to walrus parser could keep track of the original name in the WAT.

Implementations

impl Type

pub fn id(&self) -> TypeId

Get the id of this type.

pub fn kind(&self) -> &CompositeType

Get a reference to the composite type.

pub fn kind_mut(&mut self) -> &mut CompositeType

Get a mutable reference to the composite type.

pub fn params(&self) -> &[ValType]

Get the parameters to this function type.

Panics

Panics if this type is not a function type.

pub fn results(&self) -> &[ValType]

Get the results of this function type.

Panics

Panics if this type is not a function type.

pub fn as_function(&self) -> Option<&FunctionType>

Returns this type’s composite type as a function type, if it is one.

pub fn as_struct(&self) -> Option<&StructType>

Returns this type’s composite type as a struct type, if it is one.

pub fn as_array(&self) -> Option<&ArrayType>

Returns this type’s composite type as an array type, if it is one.

pub fn is_function(&self) -> bool

Whether this type is a function type.

pub fn is_struct(&self) -> bool

Whether this type is a struct type.

pub fn is_array(&self) -> bool

Whether this type is an array type.

pub fn referenced_types(&self, out: &mut Vec<TypeId>)

Collect all TypeIds that this type directly references.

This includes concrete heap types in parameters/results/fields and the supertype, if any. Used by the GC pass to transitively keep types alive.

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

impl Hash for Type

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Type

fn cmp(&self, rhs: &Type) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Type

fn eq(&self, rhs: &Type) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Type

fn partial_cmp(&self, rhs: &Type) -> 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.