Struct RefType 

pub struct RefType { /* private fields */ }

Opaque references to data in the Wasm heap or to host data.

Subtyping and Equality

RefType 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 RefType::matches and Ref::matches_ty methods 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 RefType::eq method.

Implementations

impl RefType

pub const EXTERNREF: Self

Available on crate feature runtime only.

The externref type, aka (ref null extern).

pub const NULLEXTERNREF: Self

Available on crate feature runtime only.

The nullexternref type, aka (ref null noextern).

pub const FUNCREF: Self

Available on crate feature runtime only.

The funcref type, aka (ref null func).

pub const NULLFUNCREF: Self

Available on crate feature runtime only.

The nullfuncref type, aka (ref null nofunc).

pub const ANYREF: Self

Available on crate feature runtime only.

The anyref type, aka (ref null any).

pub const EQREF: Self

Available on crate feature runtime only.

The eqref type, aka (ref null eq).

pub const I31REF: Self

Available on crate feature runtime only.

The i31ref type, aka (ref null i31).

pub const ARRAYREF: Self

Available on crate feature runtime only.

The arrayref type, aka (ref null array).

pub const STRUCTREF: Self

Available on crate feature runtime only.

The structref type, aka (ref null struct).

pub const NULLREF: Self

Available on crate feature runtime only.

The nullref type, aka (ref null none).

pub const CONTREF: Self

Available on crate feature runtime only.

The contref type, aka (ref null cont).

pub const NULLCONTREF: Self

Available on crate feature runtime only.

The nullcontref type, aka (ref null nocont).

pub const EXNREF: Self

Available on crate feature runtime only.

The exnref type, aka (ref null exn).

pub const NULLEXNREF: Self

Available on crate feature runtime only.

The nullexnref type, aka (ref null noexn).

pub fn new(is_nullable: bool, heap_type: HeapType) -> RefType

Available on crate feature runtime only.

Construct a new reference type.

pub fn is_nullable(&self) -> bool

Available on crate feature runtime only.

Can this type of reference be null?

pub fn heap_type(&self) -> &HeapType

Available on crate feature runtime only.

The heap type that this is a reference to.

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

Available on crate feature runtime only.

Does this reference type match the other?

That is, is this reference type a subtype of the other?

Panics

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

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

Available on crate feature runtime only.

Is reference type a precisely equal to reference type b?

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

Panics

Panics if either type is associated with a different engine.

Trait Implementations

impl Clone for RefType

Available on crate feature runtime only.

fn clone(&self) -> RefType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RefType

Available on crate feature runtime only.

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

Formats the value using the given formatter.

impl Display for RefType

Available on crate feature runtime only.

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

Formats the value using the given formatter.

impl From<RefType> for StorageType

Available on crate feature runtime only.

fn from(r: RefType) -> Self

Converts to this type from the input type.

impl From<RefType> for ValType

Available on crate feature runtime only.

fn from(r: RefType) -> Self

Converts to this type from the input type.

impl Hash for RefType

Available on crate feature runtime only.

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.