Struct RefType

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

A reference type.

The reference types proposal first introduced externref and funcref.

The function references proposal introduced typed function references.

The GC proposal introduces heap types: any, eq, i31, struct, array, nofunc, noextern, none.

Implementations

impl RefType

pub const FUNCREF: Self = _

A nullable untyped function reference aka (ref null func) aka funcref aka anyfunc.

pub const EXTERNREF: Self = _

A nullable reference to an extern object aka (ref null extern) aka externref.

pub const ANYREF: Self = _

A nullable reference to any object aka (ref null any) aka anyref.

pub const NULLREF: Self = _

A nullable reference to no object aka (ref null none) aka nullref.

pub const NULLEXTERNREF: Self = _

A nullable reference to a noextern object aka (ref null noextern) aka nullexternref.

pub const NULLFUNCREF: Self = _

A nullable reference to a nofunc object aka (ref null nofunc) aka nullfuncref.

pub const EQREF: Self = _

A nullable reference to an eq object aka (ref null eq) aka eqref.

pub const STRUCTREF: Self = _

A nullable reference to a struct aka (ref null struct) aka structref.

pub const ARRAYREF: Self = _

A nullable reference to an array aka (ref null array) aka arrayref.

pub const I31REF: Self = _

A nullable reference to an i31 object aka (ref null i31) aka i31ref.

pub const EXNREF: Self = _

A nullable reference to an exception object aka (ref null exn) aka exnref.

pub const NULLEXNREF: Self = _

A nullable reference to a noexn object aka (ref null noexn) aka nullexnref.

pub const CONTREF: Self = _

A nullable reference to a cont object aka (ref null cont) aka contref.

pub const NULLCONTREF: Self = _

A nullable reference to a nocont object aka (ref null nocont) aka nullcontref.

pub const FUNC: Self = _

A non-nullable untyped function reference aka (ref func).

pub const EXTERN: Self = _

A non-nullable reference to an extern object aka (ref extern).

pub const ANY: Self = _

A non-nullable reference to any object aka (ref any).

pub const NONE: Self = _

A non-nullable reference to no object aka (ref none).

pub const NOEXTERN: Self = _

A non-nullable reference to a noextern object aka (ref noextern).

pub const NOFUNC: Self = _

A non-nullable reference to a nofunc object aka (ref nofunc).

pub const EQ: Self = _

A non-nullable reference to an eq object aka (ref eq).

pub const STRUCT: Self = _

A non-nullable reference to a struct aka (ref struct).

pub const ARRAY: Self = _

A non-nullable reference to an array aka (ref array).

pub const I31: Self = _

A non-nullable reference to an i31 object aka (ref i31).

pub const EXN: Self = _

A non-nullable reference to an exn object aka (ref exn).

pub const NOEXN: Self = _

A non-nullable reference to a noexn object aka (ref noexn).

pub const CONT: Self = _

A non-nullable reference to a cont object aka (ref cont).

pub const NOCONT: Self = _

A non-nullable reference to a nocont object aka (ref nocont).

pub fn concrete(nullable: bool, index: PackedIndex) -> Self

Create a reference to a concrete Wasm-defined type at the given index.

Returns None when the type index is beyond this crate’s implementation limits and therefore is not representable.

pub fn new(nullable: bool, heap_type: HeapType) -> Option<Self>

Create a new RefType.

Returns None when the heap type’s type index (if any) is beyond this crate’s implementation limits and therefore is not representable.

pub fn difference(a: RefType, b: RefType) -> RefType

Compute the type difference between the two given ref types.

pub const fn is_concrete_type_ref(&self) -> bool

Is this a reference to an concrete type?

pub fn type_index(&self) -> Option<PackedIndex>

If this is a reference to a concrete Wasm-defined type, get its type index.

pub const fn is_func_ref(&self) -> bool

Is this the abstract untyped function reference type aka (ref null func) aka funcref aka anyfunc?

pub const fn is_extern_ref(&self) -> bool

Is this the abstract external reference type aka (ref null extern) aka externref?

pub const fn is_array_ref(&self) -> bool

Is this the abstract untyped array reference type aka (ref null array) aka arrayref?

pub const fn is_struct_ref(&self) -> bool

Is this the abstract untyped struct reference type aka (ref null struct) aka structref?

pub const fn is_cont_ref(&self) -> bool

Is this the abstract untyped cont reference type aka (ref null cont) aka contref?

pub const fn is_nullable(&self) -> bool

Is this ref type nullable?

pub const fn as_non_null(&self) -> Self

Get the non-nullable version of this ref type.

pub const fn nullable(&self) -> Self

Get the nullable version of this ref type.

pub const fn shared(&self) -> Option<Self>

Get the shared version of this ref type as long as it is abstract.

pub fn heap_type(&self) -> HeapType

Get the heap type that this is a reference to.

Trait Implementations

impl Clone for RefType

fn clone(&self) -> RefType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RefType

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

Formats the value using the given formatter.

impl Display for RefType

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

Formats the value using the given formatter.

impl From<RefType> for ValType

fn from(ty: RefType) -> ValType

Converts to this type from the input type.

impl<'a> FromReader<'a> for RefType

fn from_reader(reader: &mut BinaryReader<'a>) -> Result<Self>

Attempts to read Self from the provided binary reader, returning an error if it is unable to do so.

impl Hash for RefType

fn hash<__H: Hasher>(&self, state: &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 RefType

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

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

fn partial_cmp(&self, other: &RefType) -> 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 Copy for RefType

impl Eq for RefType

impl StructuralPartialEq for RefType