Struct ArrayType

pub struct ArrayType { /* private fields */ }

The type of a WebAssembly array.

WebAssembly arrays are dynamically-sized, but not resizable. They contain either unpacked Vals or packed 8-/16-bit integers.

Subtyping and Equality

ArrayType does not implement Eq, because reference types have a subtyping relationship, and so 99.99% of the time you actually want to check whether one type matches (i.e. is a subtype of) another type. You can use the ArrayType::matches method to perform these types of checks. If, however, you are in that 0.01% scenario where you need to check precise equality between types, you can use the ArrayType::eq method.

Implementations

impl ArrayType

pub fn new(engine: &Engine, field_type: FieldType) -> ArrayType

Construct a new ArrayType with the given field type’s mutability and storage type.

The new ArrayType will be final and without a supertype.

The result will be associated with the given engine, and attempts to use it with other engines will panic (for example, checking whether it is a subtype of another array type that is associated with a different engine).

Panics

Panics if the given field type is not associated with the given engine.

pub fn with_finality_and_supertype( engine: &Engine, finality: Finality, supertype: Option<&ArrayType>, field_type: FieldType, ) -> Result<ArrayType, Error>

Construct a new StructType with the given finality, supertype, and fields.

The result will be associated with the given engine, and attempts to use it with other engines will panic (for example, checking whether it is a subtype of another struct type that is associated with a different engine).

Returns an error if the supertype is final, or if this type does not match the supertype.

Panics

Panics if the given field type is not associated with the given engine.

pub fn engine(&self) -> &Engine

Get the engine that this array type is associated with.

pub fn finality(&self) -> Finality

Get the finality of this array type.

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

Get the supertype of this array type, if any.

pub fn field_type(&self) -> FieldType

Get this array’s underlying field type.

The field type contains information about both this array type’s mutability and the storage type used for its elements.

pub fn mutability(&self) -> Mutability

Get this array type’s mutability and whether its instances’ elements can be updated or not.

This is a convenience method providing a short-hand for my_array_type.field_type().mutability().

pub fn element_type(&self) -> StorageType

Get the storage type used for this array type’s elements.

This is a convenience method providing a short-hand for my_array_type.field_type().element_type().

pub fn matches(&self, other: &ArrayType) -> bool

Does this array type match the other array type?

That is, is this function type a subtype of the other array type?

Panics

Panics if either type is associated with a different engine from the other.

pub fn eq(a: &ArrayType, b: &ArrayType) -> bool

Is array type a precisely equal to array type b?

Returns false even if a is a subtype of b or vice versa, if they are not exactly the same array type.

Panics

Panics if either type is associated with a different engine from the other.

Trait Implementations

impl Clone for ArrayType

fn clone(&self) -> ArrayType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArrayType

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

Formats the value using the given formatter.

impl Display for ArrayType

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

Formats the value using the given formatter.

impl From<ArrayType> for HeapType

fn from(a: ArrayType) -> HeapType

Converts to this type from the input type.

impl Hash for ArrayType

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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.